From 12d5db6465ef716c1462ba6039ad9146f1e3a8cd Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Sat, 21 Jan 2023 12:47:23 -0800 Subject: [PATCH] fix(deps): update dependency @octokit/types to v9 * fix(deps): update dependency @octokit/types to v9 * chore: cleanup GHES 3.0 cache file * feat: drop support for GHES 3.2 and GHES 3.3 BREAKING CHANGE: drop support for EOL'd versions of GHES * feat: add GHES 3.7 support * chore: remove generated files for GHES 3.2 and 3.3 * build: update endpoints * docs: remove references to old GHES versions Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: wolfy1339 --- README.md | 8 +- docs/ghe-32.md | 811 - docs/ghe-33.md | 822 - docs/ghe-34.md | 26 +- docs/ghe-35.md | 26 +- docs/ghe-36.md | 70 +- package-lock.json | 72 +- package.json | 2 +- .../generated/ghe30-endpoints.json | 47937 -------------- .../generated/ghe32-endpoints.json | 53408 --------------- .../generated/ghe33-endpoints.json | 54277 ---------------- .../generated/ghe34-endpoints.json | 1039 +- .../generated/ghe35-endpoints.json | 1054 +- .../generated/ghe36-endpoints.json | 2070 +- scripts/update-endpoints/ghe-versions.js | 2 +- src/generated/ghe-32-admin-endpoints.ts | 136 - src/generated/ghe-32-endpoints.ts | 1556 - src/generated/ghe-33-admin-endpoints.ts | 136 - src/generated/ghe-33-endpoints.ts | 1573 - src/generated/ghe-34-endpoints.ts | 52 +- src/generated/ghe-35-endpoints.ts | 52 +- src/generated/ghe-36-admin-endpoints.ts | 38 +- src/generated/ghe-36-endpoints.ts | 90 +- src/index.ts | 26 - 24 files changed, 2699 insertions(+), 162584 deletions(-) delete mode 100644 docs/ghe-32.md delete mode 100644 docs/ghe-33.md delete mode 100644 scripts/update-endpoints/generated/ghe30-endpoints.json delete mode 100644 scripts/update-endpoints/generated/ghe32-endpoints.json delete mode 100644 scripts/update-endpoints/generated/ghe33-endpoints.json delete mode 100644 src/generated/ghe-32-admin-endpoints.ts delete mode 100644 src/generated/ghe-32-endpoints.ts delete mode 100644 src/generated/ghe-33-admin-endpoints.ts delete mode 100644 src/generated/ghe-33-endpoints.ts diff --git a/README.md b/README.md index 7070643d..10882876 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Install with `npm install @octokit/core @octokit/plugin-enterprise-server`. Opti ```js const { Octokit } = require("@octokit/core"); const { - enterpriseServer32Admin, + enterpriseServer36Admin, } = require("@octokit/plugin-enterprise-server"); ``` @@ -45,7 +45,7 @@ const { ```js -const OctokitEnterprise32 = Octokit.plugin(enterpriseServer32Admin); +const OctokitEnterprise36 = Octokit.plugin(enterpriseServer36Admin); const octokit = new OctokitEnterprise32({ auth: "secret123", baseUrl: "https://github.acme-inc.com/api/v3", @@ -59,10 +59,6 @@ octokit.enterpriseAdmin.createUser({ The list of currently exported plugins are -- [`enterpriseServer32Admin`](docs/ghe-32.md#admin) -- [`enterpriseServer32`](docs/ghe-32.md#others) -- [`enterpriseServer33Admin`](docs/ghe-33.md#admin) -- [`enterpriseServer33`](docs/ghe-33.md#others) - [`enterpriseServer34Admin`](docs/ghe-34.md#admin) - [`enterpriseServer34`](docs/ghe-34.md#others) - [`enterpriseServer35Admin`](docs/ghe-35.md#admin) diff --git a/docs/ghe-32.md b/docs/ghe-32.md deleted file mode 100644 index ed6c27d1..00000000 --- a/docs/ghe-32.md +++ /dev/null @@ -1,811 +0,0 @@ -# enterpriseServer32 - - - -## Enterprise Administration - -```js -octokit.enterpriseAdmin.addAuthorizedSshKey({ authorized_key, origin }); -octokit.enterpriseAdmin.createEnterpriseServerLicense({ - license, - password, - settings, - origin, -}); -octokit.enterpriseAdmin.createGlobalWebhook({ name, config, events, active }); -octokit.enterpriseAdmin.createImpersonationOAuthToken({ username, scopes }); -octokit.enterpriseAdmin.createOrg({ login, admin, profile_name }); -octokit.enterpriseAdmin.createPreReceiveEnvironment({ name, image_url }); -octokit.enterpriseAdmin.createPreReceiveHook({ - name, - script, - script_repository, - environment, - enforcement, - allow_downstream_configuration, -}); -octokit.enterpriseAdmin.createUser({ login, email }); -octokit.enterpriseAdmin.deleteGlobalWebhook({ hook_id }); -octokit.enterpriseAdmin.deleteImpersonationOAuthToken({ username }); -octokit.enterpriseAdmin.deletePersonalAccessToken({ token_id }); -octokit.enterpriseAdmin.deletePreReceiveEnvironment({ - pre_receive_environment_id, -}); -octokit.enterpriseAdmin.deletePreReceiveHook({ pre_receive_hook_id }); -octokit.enterpriseAdmin.deletePublicKey({ key_ids }); -octokit.enterpriseAdmin.deleteUser({ username }); -octokit.enterpriseAdmin.demoteSiteAdministrator({ username }); -octokit.enterpriseAdmin.disableSelectedOrganizationGithubActionsEnterprise({ - enterprise, - org_id, -}); -octokit.enterpriseAdmin.enableOrDisableMaintenanceMode({ maintenance, origin }); -octokit.enterpriseAdmin.enableSelectedOrganizationGithubActionsEnterprise({ - enterprise, - org_id, -}); -octokit.enterpriseAdmin.getAllAuthorizedSshKeys({ origin }); -octokit.enterpriseAdmin.getAllStats(); -octokit.enterpriseAdmin.getAllowedActionsEnterprise({ enterprise }); -octokit.enterpriseAdmin.getAnnouncement(); -octokit.enterpriseAdmin.getCommentStats(); -octokit.enterpriseAdmin.getConfigurationStatus({ origin }); -octokit.enterpriseAdmin.getDownloadStatusForPreReceiveEnvironment({ - pre_receive_environment_id, -}); -octokit.enterpriseAdmin.getGistStats(); -octokit.enterpriseAdmin.getGithubActionsPermissionsEnterprise({ enterprise }); -octokit.enterpriseAdmin.getGlobalWebhook({ hook_id }); -octokit.enterpriseAdmin.getHooksStats(); -octokit.enterpriseAdmin.getIssueStats(); -octokit.enterpriseAdmin.getLicenseInformation(); -octokit.enterpriseAdmin.getMaintenanceStatus({ origin }); -octokit.enterpriseAdmin.getMilestoneStats(); -octokit.enterpriseAdmin.getOrgStats(); -octokit.enterpriseAdmin.getPagesStats(); -octokit.enterpriseAdmin.getPreReceiveEnvironment({ - pre_receive_environment_id, -}); -octokit.enterpriseAdmin.getPreReceiveHook({ pre_receive_hook_id }); -octokit.enterpriseAdmin.getPreReceiveHookForOrg({ org, pre_receive_hook_id }); -octokit.enterpriseAdmin.getPreReceiveHookForRepo({ - owner, - repo, - pre_receive_hook_id, -}); -octokit.enterpriseAdmin.getPullRequestStats(); -octokit.enterpriseAdmin.getRepoStats(); -octokit.enterpriseAdmin.getSettings({ origin }); -octokit.enterpriseAdmin.getUserStats(); -octokit.enterpriseAdmin.listGlobalWebhooks({ per_page, page }); -octokit.enterpriseAdmin.listPersonalAccessTokens({ per_page, page }); -octokit.enterpriseAdmin.listPreReceiveEnvironments({ - per_page, - page, - direction, - sort, -}); -octokit.enterpriseAdmin.listPreReceiveHooks({ - per_page, - page, - direction, - sort, -}); -octokit.enterpriseAdmin.listPreReceiveHooksForOrg({ - org, - per_page, - page, - direction, - sort, -}); -octokit.enterpriseAdmin.listPreReceiveHooksForRepo({ - owner, - repo, - per_page, - page, - direction, - sort, -}); -octokit.enterpriseAdmin.listPublicKeys({ - per_page, - page, - direction, - sort, - since, -}); -octokit.enterpriseAdmin.listSelectedOrganizationsEnabledGithubActionsEnterprise( - { enterprise, per_page, page } -); -octokit.enterpriseAdmin.pingGlobalWebhook({ hook_id }); -octokit.enterpriseAdmin.promoteUserToBeSiteAdministrator({ username }); -octokit.enterpriseAdmin.removeAnnouncement(); -octokit.enterpriseAdmin.removeAuthorizedSshKey({ authorized_key, origin }); -octokit.enterpriseAdmin.removePreReceiveHookEnforcementForOrg({ - org, - pre_receive_hook_id, -}); -octokit.enterpriseAdmin.removePreReceiveHookEnforcementForRepo({ - owner, - repo, - pre_receive_hook_id, -}); -octokit.enterpriseAdmin.setAllowedActionsEnterprise({ - enterprise, - github_owned_allowed, - patterns_allowed, -}); -octokit.enterpriseAdmin.setAnnouncement({ announcement, expires_at }); -octokit.enterpriseAdmin.setGithubActionsPermissionsEnterprise({ - enterprise, - enabled_organizations, - allowed_actions, -}); -octokit.enterpriseAdmin.setSelectedOrganizationsEnabledGithubActionsEnterprise({ - enterprise, - selected_organization_ids, -}); -octokit.enterpriseAdmin.setSettings({ settings, origin }); -octokit.enterpriseAdmin.startConfigurationProcess({ origin }); -octokit.enterpriseAdmin.startPreReceiveEnvironmentDownload({ - pre_receive_environment_id, -}); -octokit.enterpriseAdmin.suspendUser({ username, reason }); -octokit.enterpriseAdmin.syncLdapMappingForTeam({ team_id }); -octokit.enterpriseAdmin.syncLdapMappingForUser({ username }); -octokit.enterpriseAdmin.unsuspendUser({ username, reason }); -octokit.enterpriseAdmin.updateGlobalWebhook({ - hook_id, - config, - events, - active, -}); -octokit.enterpriseAdmin.updateLdapMappingForTeam({ team_id, ldap_dn }); -octokit.enterpriseAdmin.updateLdapMappingForUser({ username, ldap_dn }); -octokit.enterpriseAdmin.updateOrgName({ org, login }); -octokit.enterpriseAdmin.updatePreReceiveEnvironment({ - pre_receive_environment_id, - name, - image_url, -}); -octokit.enterpriseAdmin.updatePreReceiveHook({ - pre_receive_hook_id, - name, - script, - script_repository, - environment, - enforcement, - allow_downstream_configuration, -}); -octokit.enterpriseAdmin.updatePreReceiveHookEnforcementForOrg({ - org, - pre_receive_hook_id, - enforcement, - allow_downstream_configuration, -}); -octokit.enterpriseAdmin.updatePreReceiveHookEnforcementForRepo({ - owner, - repo, - pre_receive_hook_id, - enforcement, -}); -octokit.enterpriseAdmin.updateUsernameForUser({ username, login }); -octokit.enterpriseAdmin.upgradeLicense({ license, origin }); -``` - - - -## Others - -```js -octokit.actions.addSelectedRepoToOrgSecret({org, secret_name, repository_id}); -octokit.actions.cancelWorkflowRun({owner, repo, run_id}); -octokit.actions.createOrUpdateEnvironmentSecret({repository_id, environment_name, secret_name, encrypted_value, key_id}); -octokit.actions.createOrUpdateOrgSecret({org, secret_name, encrypted_value, key_id, visibility, selected_repository_ids}); -octokit.actions.createOrUpdateRepoSecret({owner, repo, secret_name, encrypted_value, key_id}); -octokit.actions.createRegistrationTokenForOrg({org}); -octokit.actions.createRegistrationTokenForRepo({owner, repo}); -octokit.actions.createRemoveTokenForOrg({org}); -octokit.actions.createRemoveTokenForRepo({owner, repo}); -octokit.actions.createWorkflowDispatch({owner, repo, workflow_id, ref, inputs}); -octokit.actions.deleteArtifact({owner, repo, artifact_id}); -octokit.actions.deleteEnvironmentSecret({repository_id, environment_name, secret_name}); -octokit.actions.deleteOrgSecret({org, secret_name}); -octokit.actions.deleteRepoSecret({owner, repo, secret_name}); -octokit.actions.deleteSelfHostedRunnerFromOrg({org, runner_id}); -octokit.actions.deleteSelfHostedRunnerFromRepo({owner, repo, runner_id}); -octokit.actions.deleteWorkflowRun({owner, repo, run_id}); -octokit.actions.deleteWorkflowRunLogs({owner, repo, run_id}); -octokit.actions.disableSelectedRepositoryGithubActionsOrganization({org, repository_id}); -octokit.actions.disableWorkflow({owner, repo, workflow_id}); -octokit.actions.downloadArtifact({owner, repo, artifact_id, archive_format}); -octokit.actions.downloadJobLogsForWorkflowRun({owner, repo, job_id}); -octokit.actions.downloadWorkflowRunLogs({owner, repo, run_id}); -octokit.actions.enableSelectedRepositoryGithubActionsOrganization({org, repository_id}); -octokit.actions.enableWorkflow({owner, repo, workflow_id}); -octokit.actions.getAllowedActionsOrganization({org}); -octokit.actions.getAllowedActionsRepository({owner, repo}); -octokit.actions.getArtifact({owner, repo, artifact_id}); -octokit.actions.getEnvironmentPublicKey({repository_id, environment_name}); -octokit.actions.getEnvironmentSecret({repository_id, environment_name, secret_name}); -octokit.actions.getGithubActionsPermissionsOrganization({org}); -octokit.actions.getGithubActionsPermissionsRepository({owner, repo}); -octokit.actions.getJobForWorkflowRun({owner, repo, job_id}); -octokit.actions.getOrgPublicKey({org}); -octokit.actions.getOrgSecret({org, secret_name}); -octokit.actions.getPendingDeploymentsForRun({owner, repo, run_id}); -octokit.actions.getRepoPublicKey({owner, repo}); -octokit.actions.getRepoSecret({owner, repo, secret_name}); -octokit.actions.getReviewsForRun({owner, repo, run_id}); -octokit.actions.getSelfHostedRunnerForOrg({org, runner_id}); -octokit.actions.getSelfHostedRunnerForRepo({owner, repo, runner_id}); -octokit.actions.getWorkflow({owner, repo, workflow_id}); -octokit.actions.getWorkflowRun({owner, repo, run_id, exclude_pull_requests}); -octokit.actions.listArtifactsForRepo({owner, repo, per_page, page}); -octokit.actions.listEnvironmentSecrets({repository_id, environment_name, per_page, page}); -octokit.actions.listJobsForWorkflowRun({owner, repo, run_id, filter, per_page, page}); -octokit.actions.listOrgSecrets({org, per_page, page}); -octokit.actions.listRepoSecrets({owner, repo, per_page, page}); -octokit.actions.listRepoWorkflows({owner, repo, per_page, page}); -octokit.actions.listRunnerApplicationsForOrg({org}); -octokit.actions.listRunnerApplicationsForRepo({owner, repo}); -octokit.actions.listSelectedReposForOrgSecret({org, secret_name, page, per_page}); -octokit.actions.listSelectedRepositoriesEnabledGithubActionsOrganization({org, per_page, page}); -octokit.actions.listSelfHostedRunnersForOrg({org, per_page, page}); -octokit.actions.listSelfHostedRunnersForRepo({owner, repo, per_page, page}); -octokit.actions.listWorkflowRunArtifacts({owner, repo, run_id, per_page, page}); -octokit.actions.listWorkflowRuns({owner, repo, workflow_id, actor, branch, event, status, per_page, page, created, exclude_pull_requests}); -octokit.actions.listWorkflowRunsForRepo({owner, repo, actor, branch, event, status, per_page, page, created, exclude_pull_requests}); -octokit.actions.reRunWorkflow({owner, repo, run_id}); -octokit.actions.removeSelectedRepoFromOrgSecret({org, secret_name, repository_id}); -octokit.actions.reviewPendingDeploymentsForRun({owner, repo, run_id, environment_ids, state, comment}); -octokit.actions.setAllowedActionsOrganization({org, github_owned_allowed, patterns_allowed}); -octokit.actions.setAllowedActionsRepository({owner, repo, github_owned_allowed, patterns_allowed}); -octokit.actions.setGithubActionsPermissionsOrganization({org, enabled_repositories, allowed_actions}); -octokit.actions.setGithubActionsPermissionsRepository({owner, repo, enabled, allowed_actions}); -octokit.actions.setSelectedReposForOrgSecret({org, secret_name, selected_repository_ids}); -octokit.actions.setSelectedRepositoriesEnabledGithubActionsOrganization({org, selected_repository_ids}); -octokit.activity.checkRepoIsStarredByAuthenticatedUser({owner, repo}); -octokit.activity.deleteRepoSubscription({owner, repo}); -octokit.activity.deleteThreadSubscription({thread_id}); -octokit.activity.getFeeds(); -octokit.activity.getRepoSubscription({owner, repo}); -octokit.activity.getThread({thread_id}); -octokit.activity.getThreadSubscriptionForAuthenticatedUser({thread_id}); -octokit.activity.listEventsForAuthenticatedUser({username, per_page, page}); -octokit.activity.listNotificationsForAuthenticatedUser({all, participating, since, before, page, per_page}); -octokit.activity.listOrgEventsForAuthenticatedUser({username, org, per_page, page}); -octokit.activity.listPublicEvents({per_page, page}); -octokit.activity.listPublicEventsForRepoNetwork({owner, repo, per_page, page}); -octokit.activity.listPublicEventsForUser({username, per_page, page}); -octokit.activity.listPublicOrgEvents({org, per_page, page}); -octokit.activity.listReceivedEventsForUser({username, per_page, page}); -octokit.activity.listReceivedPublicEventsForUser({username, per_page, page}); -octokit.activity.listRepoEvents({owner, repo, per_page, page}); -octokit.activity.listRepoNotificationsForAuthenticatedUser({owner, repo, all, participating, since, before, per_page, page}); -octokit.activity.listReposStarredByAuthenticatedUser({sort, direction, per_page, page}); -octokit.activity.listReposStarredByUser({username, sort, direction, per_page, page}); -octokit.activity.listReposWatchedByUser({username, per_page, page}); -octokit.activity.listStargazersForRepo({owner, repo, per_page, page}); -octokit.activity.listWatchedReposForAuthenticatedUser({per_page, page}); -octokit.activity.listWatchersForRepo({owner, repo, per_page, page}); -octokit.activity.markNotificationsAsRead({last_read_at, read}); -octokit.activity.markRepoNotificationsAsRead({owner, repo, last_read_at}); -octokit.activity.markThreadAsRead({thread_id}); -octokit.activity.setRepoSubscription({owner, repo, subscribed, ignored}); -octokit.activity.setThreadSubscription({thread_id, ignored}); -octokit.activity.starRepoForAuthenticatedUser({owner, repo}); -octokit.activity.unstarRepoForAuthenticatedUser({owner, repo}); -octokit.apps.addRepoToInstallation({installation_id, repository_id}); -octokit.apps.addRepoToInstallationForAuthenticatedUser({installation_id, repository_id}); -octokit.apps.checkAuthorization({client_id, access_token}); -octokit.apps.checkToken({client_id, access_token}); -octokit.apps.createContentAttachment({content_reference_id, title, body}); -octokit.apps.createContentAttachmentForRepo({owner, repo, content_reference_id, title, body}); -octokit.apps.createFromManifest({code}); -octokit.apps.createInstallationAccessToken({installation_id, repositories, repository_ids, permissions}); -octokit.apps.deleteAuthorization({client_id, access_token}); -octokit.apps.deleteInstallation({installation_id}); -octokit.apps.deleteToken({client_id, access_token}); -octokit.apps.getAuthenticated(); -octokit.apps.getBySlug({app_slug}); -octokit.apps.getInstallation({installation_id}); -octokit.apps.getOrgInstallation({org}); -octokit.apps.getRepoInstallation({owner, repo}); -octokit.apps.getUserInstallation({username}); -octokit.apps.getWebhookConfigForApp(); -octokit.apps.getWebhookDelivery({delivery_id}); -octokit.apps.listInstallationReposForAuthenticatedUser({installation_id, per_page, page}); -octokit.apps.listInstallations({per_page, page, since, outdated}); -octokit.apps.listInstallationsForAuthenticatedUser({per_page, page}); -octokit.apps.listReposAccessibleToInstallation({per_page, page}); -octokit.apps.listWebhookDeliveries({per_page, cursor}); -octokit.apps.redeliverWebhookDelivery({delivery_id}); -octokit.apps.removeRepoFromInstallation({installation_id, repository_id}); -octokit.apps.removeRepoFromInstallationForAuthenticatedUser({installation_id, repository_id}); -octokit.apps.resetAuthorization({client_id, access_token}); -octokit.apps.resetToken({client_id, access_token}); -octokit.apps.revokeAuthorizationForApplication({client_id, access_token}); -octokit.apps.revokeGrantForApplication({client_id, access_token}); -octokit.apps.revokeInstallationAccessToken(); -octokit.apps.scopeToken({client_id, access_token, target, target_id, repositories, repository_ids, permissions}); -octokit.apps.suspendInstallation({installation_id}); -octokit.apps.unsuspendInstallation({installation_id}); -octokit.apps.updateWebhookConfigForApp({url, content_type, secret, insecure_ssl}); -octokit.checks.create({owner, repo, status, *}); -octokit.checks.createSuite({owner, repo, head_sha}); -octokit.checks.get({owner, repo, check_run_id}); -octokit.checks.getSuite({owner, repo, check_suite_id}); -octokit.checks.listAnnotations({owner, repo, check_run_id, per_page, page}); -octokit.checks.listForRef({owner, repo, ref, check_name, status, filter, per_page, page, app_id}); -octokit.checks.listForSuite({owner, repo, check_suite_id, check_name, status, filter, per_page, page}); -octokit.checks.listSuitesForRef({owner, repo, ref, app_id, check_name, per_page, page}); -octokit.checks.rerequestSuite({owner, repo, check_suite_id}); -octokit.checks.setSuitesPreferences({owner, repo, auto_trigger_checks}); -octokit.checks.update({owner, repo, check_run_id, name, details_url, external_id, started_at, status, conclusion, completed_at, output, actions}); -octokit.codeScanning.deleteAnalysis({owner, repo, analysis_id, confirm_delete}); -octokit.codeScanning.getAlert({owner, repo, alert_number}); -octokit.codeScanning.getAnalysis({owner, repo, analysis_id}); -octokit.codeScanning.getSarif({owner, repo, sarif_id}); -octokit.codeScanning.listAlertInstances({owner, repo, alert_number, page, per_page, ref}); -octokit.codeScanning.listAlertsForRepo({owner, repo, tool_name, tool_guid, page, per_page, ref, state}); -octokit.codeScanning.listAlertsInstances({owner, repo, alert_number, page, per_page, ref}); -octokit.codeScanning.listRecentAnalyses({owner, repo, tool_name, tool_guid, page, per_page, ref, sarif_id}); -octokit.codeScanning.updateAlert({owner, repo, alert_number, state, dismissed_reason}); -octokit.codeScanning.uploadSarif({owner, repo, commit_sha, ref, sarif, checkout_uri, started_at, tool_name}); -octokit.codesOfConduct.getAllCodesOfConduct(); -octokit.codesOfConduct.getConductCode({key}); -octokit.codesOfConduct.getForRepo({owner, repo}); -octokit.emojis.get(); -octokit.gists.checkIsStarred({gist_id}); -octokit.gists.create({description, files, public}); -octokit.gists.createComment({gist_id, body}); -octokit.gists.delete({gist_id}); -octokit.gists.deleteComment({gist_id, comment_id}); -octokit.gists.fork({gist_id}); -octokit.gists.get({gist_id}); -octokit.gists.getComment({gist_id, comment_id}); -octokit.gists.getRevision({gist_id, sha}); -octokit.gists.list({since, per_page, page}); -octokit.gists.listComments({gist_id, per_page, page}); -octokit.gists.listCommits({gist_id, per_page, page}); -octokit.gists.listForUser({username, since, per_page, page}); -octokit.gists.listForks({gist_id, per_page, page}); -octokit.gists.listPublic({since, per_page, page}); -octokit.gists.listStarred({since, per_page, page}); -octokit.gists.star({gist_id}); -octokit.gists.unstar({gist_id}); -octokit.gists.update({gist_id, description, files}); -octokit.gists.updateComment({gist_id, comment_id, body}); -octokit.git.createBlob({owner, repo, content, encoding}); -octokit.git.createCommit({owner, repo, message, tree, parents, author, committer, signature}); -octokit.git.createRef({owner, repo, ref, sha, key}); -octokit.git.createTag({owner, repo, tag, message, object, type, tagger}); -octokit.git.createTree({owner, repo, tree, base_tree}); -octokit.git.deleteRef({owner, repo, ref}); -octokit.git.getBlob({owner, repo, file_sha}); -octokit.git.getCommit({owner, repo, commit_sha}); -octokit.git.getRef({owner, repo, ref}); -octokit.git.getTag({owner, repo, tag_sha}); -octokit.git.getTree({owner, repo, tree_sha, recursive}); -octokit.git.listMatchingRefs({owner, repo, ref}); -octokit.git.updateRef({owner, repo, ref, sha, force}); -octokit.gitignore.getAllTemplates(); -octokit.gitignore.getTemplate({name}); -octokit.issues.addAssignees({owner, repo, issue_number, assignees}); -octokit.issues.addLabels({owner, repo, issue_number, labels}); -octokit.issues.checkUserCanBeAssigned({owner, repo, assignee}); -octokit.issues.create({owner, repo, title, body, assignee, milestone, labels, assignees}); -octokit.issues.createComment({owner, repo, issue_number, body}); -octokit.issues.createLabel({owner, repo, name, color, description}); -octokit.issues.createMilestone({owner, repo, title, state, description, due_on}); -octokit.issues.deleteComment({owner, repo, comment_id}); -octokit.issues.deleteLabel({owner, repo, name}); -octokit.issues.deleteMilestone({owner, repo, milestone_number}); -octokit.issues.get({owner, repo, issue_number}); -octokit.issues.getComment({owner, repo, comment_id}); -octokit.issues.getEvent({owner, repo, event_id}); -octokit.issues.getLabel({owner, repo, name}); -octokit.issues.getMilestone({owner, repo, milestone_number}); -octokit.issues.list({filter, state, labels, sort, direction, since, collab, orgs, owned, pulls, per_page, page}); -octokit.issues.listAssignees({owner, repo, per_page, page}); -octokit.issues.listComments({owner, repo, issue_number, since, per_page, page}); -octokit.issues.listCommentsForRepo({owner, repo, sort, direction, since, per_page, page}); -octokit.issues.listEvents({owner, repo, issue_number, per_page, page}); -octokit.issues.listEventsForRepo({owner, repo, per_page, page}); -octokit.issues.listEventsForTimeline({owner, repo, issue_number, per_page, page}); -octokit.issues.listForAuthenticatedUser({filter, state, labels, sort, direction, since, per_page, page}); -octokit.issues.listForOrg({org, filter, state, labels, sort, direction, since, per_page, page}); -octokit.issues.listForRepo({owner, repo, milestone, state, assignee, creator, mentioned, labels, sort, direction, since, per_page, page}); -octokit.issues.listLabelsForMilestone({owner, repo, milestone_number, per_page, page}); -octokit.issues.listLabelsForRepo({owner, repo, per_page, page}); -octokit.issues.listLabelsOnIssue({owner, repo, issue_number, per_page, page}); -octokit.issues.listMilestones({owner, repo, state, sort, direction, per_page, page}); -octokit.issues.lock({owner, repo, issue_number, lock_reason}); -octokit.issues.removeAllLabels({owner, repo, issue_number}); -octokit.issues.removeAssignees({owner, repo, issue_number, assignees}); -octokit.issues.removeLabel({owner, repo, issue_number, name}); -octokit.issues.setLabels({owner, repo, issue_number, labels}); -octokit.issues.unlock({owner, repo, issue_number}); -octokit.issues.update({owner, repo, issue_number, title, body, assignee, state, state_reason, milestone, labels, assignees}); -octokit.issues.updateComment({owner, repo, comment_id, body}); -octokit.issues.updateLabel({owner, repo, name, new_name, color, description}); -octokit.issues.updateMilestone({owner, repo, milestone_number, title, state, description, due_on}); -octokit.licenses.get({license}); -octokit.licenses.getAllCommonlyUsed({featured, per_page, page}); -octokit.licenses.getForRepo({owner, repo}); -octokit.markdown.render({text, mode, context}); -octokit.markdown.renderRaw({data}); -octokit.meta.get(); -octokit.meta.getOctocat({s}); -octokit.meta.getZen(); -octokit.meta.root(); -octokit.orgs.checkMembershipForUser({org, username}); -octokit.orgs.checkPublicMembershipForUser({org, username}); -octokit.orgs.convertMemberToOutsideCollaborator({org, username, async}); -octokit.orgs.createWebhook({org, name, config, events, active}); -octokit.orgs.deleteWebhook({org, hook_id}); -octokit.orgs.get({org}); -octokit.orgs.getMembershipForAuthenticatedUser({org}); -octokit.orgs.getMembershipForUser({org, username}); -octokit.orgs.getWebhook({org, hook_id}); -octokit.orgs.getWebhookConfigForOrg({org, hook_id}); -octokit.orgs.getWebhookDelivery({org, hook_id, delivery_id}); -octokit.orgs.list({since, per_page}); -octokit.orgs.listAppInstallations({org, per_page, page}); -octokit.orgs.listForAuthenticatedUser({per_page, page}); -octokit.orgs.listForUser({username, per_page, page}); -octokit.orgs.listMembers({org, filter, role, per_page, page}); -octokit.orgs.listMembershipsForAuthenticatedUser({state, per_page, page}); -octokit.orgs.listOutsideCollaborators({org, filter, per_page, page}); -octokit.orgs.listPublicMembers({org, per_page, page}); -octokit.orgs.listWebhookDeliveries({org, hook_id, per_page, cursor}); -octokit.orgs.listWebhooks({org, per_page, page}); -octokit.orgs.pingWebhook({org, hook_id}); -octokit.orgs.redeliverWebhookDelivery({org, hook_id, delivery_id}); -octokit.orgs.removeMember({org, username}); -octokit.orgs.removeMembershipForUser({org, username}); -octokit.orgs.removeOutsideCollaborator({org, username}); -octokit.orgs.removePublicMembershipForAuthenticatedUser({org, username}); -octokit.orgs.setMembershipForUser({org, username, role}); -octokit.orgs.setPublicMembershipForAuthenticatedUser({org, username}); -octokit.orgs.update({org, billing_email, company, email, twitter_username, location, name, description, has_organization_projects, has_repository_projects, default_repository_permission, members_can_create_repositories, members_can_create_internal_repositories, members_can_create_private_repositories, members_can_create_public_repositories, members_allowed_repository_creation_type, members_can_create_pages, blog}); -octokit.orgs.updateMembershipForAuthenticatedUser({org, state}); -octokit.orgs.updateWebhook({org, hook_id, config, events, active, name}); -octokit.orgs.updateWebhookConfigForOrg({org, hook_id, url, content_type, secret, insecure_ssl}); -octokit.projects.addCollaborator({project_id, username, permission}); -octokit.projects.createCard({column_id, note, content_id, content_type}); -octokit.projects.createColumn({project_id, name}); -octokit.projects.createForAuthenticatedUser({name, body}); -octokit.projects.createForOrg({org, name, body}); -octokit.projects.createForRepo({owner, repo, name, body}); -octokit.projects.delete({project_id}); -octokit.projects.deleteCard({card_id}); -octokit.projects.deleteColumn({column_id}); -octokit.projects.get({project_id}); -octokit.projects.getCard({card_id}); -octokit.projects.getColumn({column_id}); -octokit.projects.getPermissionForUser({project_id, username}); -octokit.projects.listCards({column_id, archived_state, per_page, page}); -octokit.projects.listCollaborators({project_id, affiliation, per_page, page}); -octokit.projects.listColumns({project_id, per_page, page}); -octokit.projects.listForOrg({org, state, per_page, page}); -octokit.projects.listForRepo({owner, repo, state, per_page, page}); -octokit.projects.listForUser({username, state, per_page, page}); -octokit.projects.moveCard({card_id, position, column_id}); -octokit.projects.moveColumn({column_id, position}); -octokit.projects.removeCollaborator({project_id, username}); -octokit.projects.update({project_id, name, body, state, organization_permission, private}); -octokit.projects.updateCard({card_id, note, archived}); -octokit.projects.updateColumn({column_id, name}); -octokit.pulls.checkIfMerged({owner, repo, pull_number}); -octokit.pulls.create({owner, repo, title, head, base, body, maintainer_can_modify, draft, issue}); -octokit.pulls.createReplyForReviewComment({owner, repo, pull_number, comment_id, body}); -octokit.pulls.createReview({owner, repo, pull_number, commit_id, body, event, comments}); -octokit.pulls.createReviewComment({owner, repo, pull_number, body, commit_id, path, position, side, line, start_line, start_side, in_reply_to}); -octokit.pulls.deletePendingReview({owner, repo, pull_number, review_id}); -octokit.pulls.deleteReviewComment({owner, repo, comment_id}); -octokit.pulls.dismissReview({owner, repo, pull_number, review_id, message, event}); -octokit.pulls.get({owner, repo, pull_number}); -octokit.pulls.getReview({owner, repo, pull_number, review_id}); -octokit.pulls.getReviewComment({owner, repo, comment_id}); -octokit.pulls.list({owner, repo, state, head, base, sort, direction, per_page, page}); -octokit.pulls.listCommentsForReview({owner, repo, pull_number, review_id, per_page, page}); -octokit.pulls.listCommits({owner, repo, pull_number, per_page, page}); -octokit.pulls.listFiles({owner, repo, pull_number, per_page, page}); -octokit.pulls.listRequestedReviewers({owner, repo, pull_number}); -octokit.pulls.listReviewComments({owner, repo, pull_number, sort, direction, since, per_page, page}); -octokit.pulls.listReviewCommentsForRepo({owner, repo, sort, direction, since, per_page, page}); -octokit.pulls.listReviews({owner, repo, pull_number, per_page, page}); -octokit.pulls.merge({owner, repo, pull_number, commit_title, commit_message, sha, merge_method}); -octokit.pulls.removeRequestedReviewers({owner, repo, pull_number, reviewers, team_reviewers}); -octokit.pulls.requestReviewers({owner, repo, pull_number, reviewers, team_reviewers}); -octokit.pulls.submitReview({owner, repo, pull_number, review_id, body, event}); -octokit.pulls.update({owner, repo, pull_number, title, body, state, base, maintainer_can_modify}); -octokit.pulls.updateBranch({owner, repo, pull_number, expected_head_sha}); -octokit.pulls.updateReview({owner, repo, pull_number, review_id, body}); -octokit.pulls.updateReviewComment({owner, repo, comment_id, body}); -octokit.rateLimit.get(); -octokit.reactions.createForCommitComment({owner, repo, comment_id, content}); -octokit.reactions.createForIssue({owner, repo, issue_number, content}); -octokit.reactions.createForIssueComment({owner, repo, comment_id, content}); -octokit.reactions.createForPullRequestReviewComment({owner, repo, comment_id, content}); -octokit.reactions.createForRelease({owner, repo, release_id, content}); -octokit.reactions.createForTeamDiscussionCommentInOrg({org, team_slug, discussion_number, comment_number, content}); -octokit.reactions.createForTeamDiscussionCommentLegacy({team_id, discussion_number, comment_number, content}); -octokit.reactions.createForTeamDiscussionInOrg({org, team_slug, discussion_number, content}); -octokit.reactions.createForTeamDiscussionLegacy({team_id, discussion_number, content}); -octokit.reactions.deleteForCommitComment({owner, repo, comment_id, reaction_id}); -octokit.reactions.deleteForIssue({owner, repo, issue_number, reaction_id}); -octokit.reactions.deleteForIssueComment({owner, repo, comment_id, reaction_id}); -octokit.reactions.deleteForPullRequestComment({owner, repo, comment_id, reaction_id}); -octokit.reactions.deleteForRelease({owner, repo, release_id, reaction_id}); -octokit.reactions.deleteForTeamDiscussion({org, team_slug, discussion_number, reaction_id}); -octokit.reactions.deleteForTeamDiscussionComment({org, team_slug, discussion_number, comment_number, reaction_id}); -octokit.reactions.deleteLegacy({reaction_id}); -octokit.reactions.listForCommitComment({owner, repo, comment_id, content, per_page, page}); -octokit.reactions.listForIssue({owner, repo, issue_number, content, per_page, page}); -octokit.reactions.listForIssueComment({owner, repo, comment_id, content, per_page, page}); -octokit.reactions.listForPullRequestReviewComment({owner, repo, comment_id, content, per_page, page}); -octokit.reactions.listForRelease({owner, repo, release_id, content, per_page, page}); -octokit.reactions.listForTeamDiscussionCommentInOrg({org, team_slug, discussion_number, comment_number, content, per_page, page}); -octokit.reactions.listForTeamDiscussionCommentLegacy({team_id, discussion_number, comment_number, content, per_page, page}); -octokit.reactions.listForTeamDiscussionInOrg({org, team_slug, discussion_number, content, per_page, page}); -octokit.reactions.listForTeamDiscussionLegacy({team_id, discussion_number, content, per_page, page}); -octokit.repos.acceptInvitation({invitation_id}); -octokit.repos.acceptInvitationForAuthenticatedUser({invitation_id}); -octokit.repos.addAppAccessRestrictions({owner, repo, branch, apps}); -octokit.repos.addCollaborator({owner, repo, username, permission}); -octokit.repos.addStatusCheckContexts({owner, repo, branch, contexts}); -octokit.repos.addTeamAccessRestrictions({owner, repo, branch, teams}); -octokit.repos.addUserAccessRestrictions({owner, repo, branch, users}); -octokit.repos.checkCollaborator({owner, repo, username}); -octokit.repos.compareCommits({owner, repo, base, head, per_page, page}); -octokit.repos.compareCommitsWithBasehead({owner, repo, page, per_page, basehead}); -octokit.repos.createCommitComment({owner, repo, commit_sha, body, path, position, line}); -octokit.repos.createCommitSignatureProtection({owner, repo, branch}); -octokit.repos.createCommitStatus({owner, repo, sha, state, target_url, description, context}); -octokit.repos.createDeployKey({owner, repo, title, key, read_only}); -octokit.repos.createDeployment({owner, repo, ref, task, auto_merge, required_contexts, payload, environment, description, transient_environment, production_environment}); -octokit.repos.createDeploymentBranchPolicy({owner, repo, environment_name, name}); -octokit.repos.createDeploymentStatus({owner, repo, deployment_id, state, target_url, log_url, description, environment, environment_url, auto_inactive}); -octokit.repos.createDispatchEvent({owner, repo, event_type, client_payload}); -octokit.repos.createForAuthenticatedUser({name, description, homepage, private, has_issues, has_projects, has_wiki, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, delete_branch_on_merge, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, has_downloads, is_template}); -octokit.repos.createFork({owner, repo, organization}); -octokit.repos.createInOrg({org, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, is_template, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, delete_branch_on_merge, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message}); -octokit.repos.createOrUpdateEnvironment({owner, repo, environment_name, wait_timer, reviewers, deployment_branch_policy}); -octokit.repos.createOrUpdateFileContents({owner, repo, path, message, content, sha, branch, committer, author}); -octokit.repos.createPagesSite({owner, repo, build_type, source}); -octokit.repos.createRelease({owner, repo, tag_name, target_commitish, name, body, draft, prerelease}); -octokit.repos.createUsingTemplate({template_owner, template_repo, owner, name, description, include_all_branches, private}); -octokit.repos.createWebhook({owner, repo, name, config, events, active}); -octokit.repos.declineInvitation({invitation_id}); -octokit.repos.declineInvitationForAuthenticatedUser({invitation_id}); -octokit.repos.delete({owner, repo}); -octokit.repos.deleteAccessRestrictions({owner, repo, branch}); -octokit.repos.deleteAdminBranchProtection({owner, repo, branch}); -octokit.repos.deleteAnEnvironment({owner, repo, environment_name}); -octokit.repos.deleteBranchProtection({owner, repo, branch}); -octokit.repos.deleteCommitComment({owner, repo, comment_id}); -octokit.repos.deleteCommitSignatureProtection({owner, repo, branch}); -octokit.repos.deleteDeployKey({owner, repo, key_id}); -octokit.repos.deleteDeployment({owner, repo, deployment_id}); -octokit.repos.deleteDeploymentBranchPolicy({owner, repo, environment_name, branch_policy_id}); -octokit.repos.deleteFile({owner, repo, path, message, sha, branch, committer, author}); -octokit.repos.deleteInvitation({owner, repo, invitation_id}); -octokit.repos.deletePagesSite({owner, repo}); -octokit.repos.deletePullRequestReviewProtection({owner, repo, branch}); -octokit.repos.deleteRelease({owner, repo, release_id}); -octokit.repos.deleteReleaseAsset({owner, repo, asset_id}); -octokit.repos.deleteWebhook({owner, repo, hook_id}); -octokit.repos.downloadTarballArchive({owner, repo, ref}); -octokit.repos.downloadZipballArchive({owner, repo, ref}); -octokit.repos.get({owner, repo}); -octokit.repos.getAccessRestrictions({owner, repo, branch}); -octokit.repos.getAdminBranchProtection({owner, repo, branch}); -octokit.repos.getAllEnvironments({owner, repo, per_page, page}); -octokit.repos.getAllStatusCheckContexts({owner, repo, branch}); -octokit.repos.getAllTopics({owner, repo, page, per_page}); -octokit.repos.getAppsWithAccessToProtectedBranch({owner, repo, branch}); -octokit.repos.getBranch({owner, repo, branch}); -octokit.repos.getBranchProtection({owner, repo, branch}); -octokit.repos.getCodeFrequencyStats({owner, repo}); -octokit.repos.getCollaboratorPermissionLevel({owner, repo, username}); -octokit.repos.getCombinedStatusForRef({owner, repo, ref, per_page, page}); -octokit.repos.getCommit({owner, repo, page, per_page, ref}); -octokit.repos.getCommitActivityStats({owner, repo}); -octokit.repos.getCommitComment({owner, repo, comment_id}); -octokit.repos.getCommitSignatureProtection({owner, repo, branch}); -octokit.repos.getContent({owner, repo, path, ref}); -octokit.repos.getContributorsStats({owner, repo}); -octokit.repos.getDeployKey({owner, repo, key_id}); -octokit.repos.getDeployment({owner, repo, deployment_id}); -octokit.repos.getDeploymentBranchPolicy({owner, repo, environment_name, branch_policy_id}); -octokit.repos.getDeploymentStatus({owner, repo, deployment_id, status_id}); -octokit.repos.getEnvironment({owner, repo, environment_name}); -octokit.repos.getLatestPagesBuild({owner, repo}); -octokit.repos.getLatestRelease({owner, repo}); -octokit.repos.getPages({owner, repo}); -octokit.repos.getPagesBuild({owner, repo, build_id}); -octokit.repos.getParticipationStats({owner, repo}); -octokit.repos.getPullRequestReviewProtection({owner, repo, branch}); -octokit.repos.getPunchCardStats({owner, repo}); -octokit.repos.getReadme({owner, repo, ref}); -octokit.repos.getReadmeInDirectory({owner, repo, dir, ref}); -octokit.repos.getRelease({owner, repo, release_id}); -octokit.repos.getReleaseAsset({owner, repo, asset_id}); -octokit.repos.getReleaseByTag({owner, repo, tag}); -octokit.repos.getStatusChecksProtection({owner, repo, branch}); -octokit.repos.getTeamsWithAccessToProtectedBranch({owner, repo, branch}); -octokit.repos.getUsersWithAccessToProtectedBranch({owner, repo, branch}); -octokit.repos.getWebhook({owner, repo, hook_id}); -octokit.repos.getWebhookConfigForRepo({owner, repo, hook_id}); -octokit.repos.getWebhookDelivery({owner, repo, hook_id, delivery_id}); -octokit.repos.listBranches({owner, repo, protected, per_page, page}); -octokit.repos.listBranchesForHeadCommit({owner, repo, commit_sha}); -octokit.repos.listCollaborators({owner, repo, affiliation, permission, per_page, page}); -octokit.repos.listCommentsForCommit({owner, repo, commit_sha, per_page, page}); -octokit.repos.listCommitCommentsForRepo({owner, repo, per_page, page}); -octokit.repos.listCommitStatusesForRef({owner, repo, ref, per_page, page}); -octokit.repos.listCommits({owner, repo, sha, path, author, since, until, per_page, page}); -octokit.repos.listContributors({owner, repo, anon, per_page, page}); -octokit.repos.listDeployKeys({owner, repo, per_page, page}); -octokit.repos.listDeploymentBranchPolicies({owner, repo, environment_name, per_page, page}); -octokit.repos.listDeploymentStatuses({owner, repo, deployment_id, per_page, page}); -octokit.repos.listDeployments({owner, repo, sha, ref, task, environment, per_page, page}); -octokit.repos.listForAuthenticatedUser({visibility, affiliation, type, sort, direction, per_page, page, since, before}); -octokit.repos.listForOrg({org, type, sort, direction, per_page, page}); -octokit.repos.listForUser({username, type, sort, direction, per_page, page}); -octokit.repos.listForks({owner, repo, sort, per_page, page}); -octokit.repos.listInvitations({owner, repo, per_page, page}); -octokit.repos.listInvitationsForAuthenticatedUser({per_page, page}); -octokit.repos.listLanguages({owner, repo}); -octokit.repos.listPagesBuilds({owner, repo, per_page, page}); -octokit.repos.listPublic({since, visibility}); -octokit.repos.listPullRequestsAssociatedWithCommit({owner, repo, commit_sha, per_page, page}); -octokit.repos.listReleaseAssets({owner, repo, release_id, per_page, page}); -octokit.repos.listReleases({owner, repo, per_page, page}); -octokit.repos.listTags({owner, repo, per_page, page}); -octokit.repos.listTeams({owner, repo, per_page, page}); -octokit.repos.listWebhookDeliveries({owner, repo, hook_id, per_page, cursor}); -octokit.repos.listWebhooks({owner, repo, per_page, page}); -octokit.repos.merge({owner, repo, base, head, commit_message}); -octokit.repos.pingWebhook({owner, repo, hook_id}); -octokit.repos.redeliverWebhookDelivery({owner, repo, hook_id, delivery_id}); -octokit.repos.removeAppAccessRestrictions({owner, repo, branch, apps}); -octokit.repos.removeCollaborator({owner, repo, username}); -octokit.repos.removeStatusCheckContexts({owner, repo, branch, contexts}); -octokit.repos.removeStatusCheckProtection({owner, repo, branch}); -octokit.repos.removeTeamAccessRestrictions({owner, repo, branch, teams}); -octokit.repos.removeUserAccessRestrictions({owner, repo, branch, users}); -octokit.repos.renameBranch({owner, repo, branch, new_name}); -octokit.repos.replaceAllTopics({owner, repo, names}); -octokit.repos.requestPagesBuild({owner, repo}); -octokit.repos.setAdminBranchProtection({owner, repo, branch}); -octokit.repos.setAppAccessRestrictions({owner, repo, branch, apps}); -octokit.repos.setStatusCheckContexts({owner, repo, branch, contexts}); -octokit.repos.setTeamAccessRestrictions({owner, repo, branch, teams}); -octokit.repos.setUserAccessRestrictions({owner, repo, branch, users}); -octokit.repos.testPushWebhook({owner, repo, hook_id}); -octokit.repos.transfer({owner, repo, new_owner, team_ids}); -octokit.repos.update({owner, repo, name, description, homepage, private, visibility, security_and_analysis, has_issues, has_projects, has_wiki, is_template, default_branch, allow_squash_merge, allow_merge_commit, allow_rebase_merge, delete_branch_on_merge, allow_update_branch, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, archived, allow_forking}); -octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions, block_creations, required_conversation_resolution, contexts}); -octokit.repos.updateCommitComment({owner, repo, comment_id, body}); -octokit.repos.updateDeploymentBranchPolicy({owner, repo, environment_name, branch_policy_id, name}); -octokit.repos.updateInformationAboutPagesSite({owner, repo, cname, https_enforced, public, build_type, source}); -octokit.repos.updateInvitation({owner, repo, invitation_id, permissions}); -octokit.repos.updatePullRequestReviewProtection({owner, repo, branch, dismissal_restrictions, dismiss_stale_reviews, require_code_owner_reviews, required_approving_review_count}); -octokit.repos.updateRelease({owner, repo, release_id, tag_name, target_commitish, name, body, draft, prerelease}); -octokit.repos.updateReleaseAsset({owner, repo, asset_id, name, label, state}); -octokit.repos.updateStatusCheckProtection({owner, repo, branch, strict, contexts}); -octokit.repos.updateWebhook({owner, repo, hook_id, config, events, add_events, remove_events, active}); -octokit.repos.updateWebhookConfigForRepo({owner, repo, hook_id, url, content_type, secret, insecure_ssl}); -octokit.repos.uploadReleaseAsset({owner, repo, release_id, name, label, data, origin}); -octokit.search.code({q, sort, order, per_page, page}); -octokit.search.commits({q, sort, order, per_page, page}); -octokit.search.issuesAndPullRequests({q, sort, order, per_page, page}); -octokit.search.labels({repository_id, q, sort, order, per_page, page}); -octokit.search.repos({q, sort, order, per_page, page}); -octokit.search.topics({q, per_page, page}); -octokit.search.users({q, sort, order, per_page, page}); -octokit.secretScanning.getAlert({owner, repo, alert_number}); -octokit.secretScanning.listAlertsForRepo({owner, repo, state, secret_type, resolution, page, per_page}); -octokit.secretScanning.updateAlert({owner, repo, alert_number, state, resolution}); -octokit.teams.addMemberLegacy({team_id, username}); -octokit.teams.addOrUpdateMembershipForUserInOrg({org, team_slug, username, role}); -octokit.teams.addOrUpdateMembershipForUserLegacy({team_id, username, role}); -octokit.teams.addOrUpdateProjectPermissionsInOrg({org, team_slug, project_id, permission}); -octokit.teams.addOrUpdateProjectPermissionsLegacy({team_id, project_id, permission}); -octokit.teams.addOrUpdateRepoPermissionsInOrg({org, team_slug, owner, repo, permission}); -octokit.teams.addOrUpdateRepoPermissionsLegacy({team_id, owner, repo, permission}); -octokit.teams.checkPermissionsForProjectInOrg({org, team_slug, project_id}); -octokit.teams.checkPermissionsForProjectLegacy({team_id, project_id}); -octokit.teams.checkPermissionsForRepoInOrg({org, team_slug, owner, repo}); -octokit.teams.checkPermissionsForRepoLegacy({team_id, owner, repo}); -octokit.teams.create({org, name, description, maintainers, repo_names, privacy, permission, parent_team_id, ldap_dn}); -octokit.teams.createDiscussionCommentInOrg({org, team_slug, discussion_number, body}); -octokit.teams.createDiscussionCommentLegacy({team_id, discussion_number, body}); -octokit.teams.createDiscussionInOrg({org, team_slug, title, body, private}); -octokit.teams.createDiscussionLegacy({team_id, title, body, private}); -octokit.teams.deleteDiscussionCommentInOrg({org, team_slug, discussion_number, comment_number}); -octokit.teams.deleteDiscussionCommentLegacy({team_id, discussion_number, comment_number}); -octokit.teams.deleteDiscussionInOrg({org, team_slug, discussion_number}); -octokit.teams.deleteDiscussionLegacy({team_id, discussion_number}); -octokit.teams.deleteInOrg({org, team_slug}); -octokit.teams.deleteLegacy({team_id}); -octokit.teams.getByName({org, team_slug}); -octokit.teams.getDiscussionCommentInOrg({org, team_slug, discussion_number, comment_number}); -octokit.teams.getDiscussionCommentLegacy({team_id, discussion_number, comment_number}); -octokit.teams.getDiscussionInOrg({org, team_slug, discussion_number}); -octokit.teams.getDiscussionLegacy({team_id, discussion_number}); -octokit.teams.getLegacy({team_id}); -octokit.teams.getMemberLegacy({team_id, username}); -octokit.teams.getMembershipForUserInOrg({org, team_slug, username}); -octokit.teams.getMembershipForUserLegacy({team_id, username}); -octokit.teams.list({org, per_page, page}); -octokit.teams.listChildInOrg({org, team_slug, per_page, page}); -octokit.teams.listChildLegacy({team_id, per_page, page}); -octokit.teams.listDiscussionCommentsInOrg({org, team_slug, discussion_number, direction, per_page, page}); -octokit.teams.listDiscussionCommentsLegacy({team_id, discussion_number, direction, per_page, page}); -octokit.teams.listDiscussionsInOrg({org, team_slug, direction, per_page, page, pinned}); -octokit.teams.listDiscussionsLegacy({team_id, direction, per_page, page}); -octokit.teams.listForAuthenticatedUser({per_page, page}); -octokit.teams.listMembersInOrg({org, team_slug, role, per_page, page}); -octokit.teams.listMembersLegacy({team_id, role, per_page, page}); -octokit.teams.listProjectsInOrg({org, team_slug, per_page, page}); -octokit.teams.listProjectsLegacy({team_id, per_page, page}); -octokit.teams.listReposInOrg({org, team_slug, per_page, page}); -octokit.teams.listReposLegacy({team_id, per_page, page}); -octokit.teams.removeMemberLegacy({team_id, username}); -octokit.teams.removeMembershipForUserInOrg({org, team_slug, username}); -octokit.teams.removeMembershipForUserLegacy({team_id, username}); -octokit.teams.removeProjectInOrg({org, team_slug, project_id}); -octokit.teams.removeProjectLegacy({team_id, project_id}); -octokit.teams.removeRepoInOrg({org, team_slug, owner, repo}); -octokit.teams.removeRepoLegacy({team_id, owner, repo}); -octokit.teams.updateDiscussionCommentInOrg({org, team_slug, discussion_number, comment_number, body}); -octokit.teams.updateDiscussionCommentLegacy({team_id, discussion_number, comment_number, body}); -octokit.teams.updateDiscussionInOrg({org, team_slug, discussion_number, title, body}); -octokit.teams.updateDiscussionLegacy({team_id, discussion_number, title, body}); -octokit.teams.updateInOrg({org, team_slug, name, description, privacy, permission, parent_team_id}); -octokit.teams.updateLegacy({team_id, name, description, privacy, permission, parent_team_id}); -octokit.users.addEmailForAuthenticated({emails}); -octokit.users.addEmailForAuthenticatedUser({emails}); -octokit.users.checkFollowingForUser({username, target_user}); -octokit.users.checkPersonIsFollowedByAuthenticated({username}); -octokit.users.createGpgKeyForAuthenticated({armored_public_key}); -octokit.users.createGpgKeyForAuthenticatedUser({armored_public_key}); -octokit.users.createPublicSshKeyForAuthenticated({title, key}); -octokit.users.createPublicSshKeyForAuthenticatedUser({title, key}); -octokit.users.deleteEmailForAuthenticated({emails}); -octokit.users.deleteEmailForAuthenticatedUser({emails}); -octokit.users.deleteGpgKeyForAuthenticated({gpg_key_id}); -octokit.users.deleteGpgKeyForAuthenticatedUser({gpg_key_id}); -octokit.users.deletePublicSshKeyForAuthenticated({key_id}); -octokit.users.deletePublicSshKeyForAuthenticatedUser({key_id}); -octokit.users.follow({username}); -octokit.users.getAuthenticated(); -octokit.users.getByUsername({username}); -octokit.users.getContextForUser({username, subject_type, subject_id}); -octokit.users.getGpgKeyForAuthenticated({gpg_key_id}); -octokit.users.getGpgKeyForAuthenticatedUser({gpg_key_id}); -octokit.users.getPublicSshKeyForAuthenticated({key_id}); -octokit.users.getPublicSshKeyForAuthenticatedUser({key_id}); -octokit.users.list({since, per_page}); -octokit.users.listEmailsForAuthenticated({per_page, page}); -octokit.users.listEmailsForAuthenticatedUser({per_page, page}); -octokit.users.listFollowedByAuthenticated({per_page, page}); -octokit.users.listFollowedByAuthenticatedUser({per_page, page}); -octokit.users.listFollowersForAuthenticatedUser({per_page, page}); -octokit.users.listFollowersForUser({username, per_page, page}); -octokit.users.listFollowingForUser({username, per_page, page}); -octokit.users.listGpgKeysForAuthenticated({per_page, page}); -octokit.users.listGpgKeysForAuthenticatedUser({per_page, page}); -octokit.users.listGpgKeysForUser({username, per_page, page}); -octokit.users.listPublicEmailsForAuthenticated({per_page, page}); -octokit.users.listPublicEmailsForAuthenticatedUser({per_page, page}); -octokit.users.listPublicKeysForUser({username, per_page, page}); -octokit.users.listPublicSshKeysForAuthenticated({per_page, page}); -octokit.users.listPublicSshKeysForAuthenticatedUser({per_page, page}); -octokit.users.unfollow({username}); -octokit.users.updateAuthenticated({name, email, blog, twitter_username, company, location, hireable, bio}); -``` diff --git a/docs/ghe-33.md b/docs/ghe-33.md deleted file mode 100644 index 6e3af912..00000000 --- a/docs/ghe-33.md +++ /dev/null @@ -1,822 +0,0 @@ -# enterpriseServer33 - - - -## Enterprise Administration - -```js -octokit.enterpriseAdmin.addAuthorizedSshKey({ authorized_key, origin }); -octokit.enterpriseAdmin.createEnterpriseServerLicense({ - license, - password, - settings, - origin, -}); -octokit.enterpriseAdmin.createGlobalWebhook({ name, config, events, active }); -octokit.enterpriseAdmin.createImpersonationOAuthToken({ username, scopes }); -octokit.enterpriseAdmin.createOrg({ login, admin, profile_name }); -octokit.enterpriseAdmin.createPreReceiveEnvironment({ name, image_url }); -octokit.enterpriseAdmin.createPreReceiveHook({ - name, - script, - script_repository, - environment, - enforcement, - allow_downstream_configuration, -}); -octokit.enterpriseAdmin.createUser({ login, email }); -octokit.enterpriseAdmin.deleteGlobalWebhook({ hook_id }); -octokit.enterpriseAdmin.deleteImpersonationOAuthToken({ username }); -octokit.enterpriseAdmin.deletePersonalAccessToken({ token_id }); -octokit.enterpriseAdmin.deletePreReceiveEnvironment({ - pre_receive_environment_id, -}); -octokit.enterpriseAdmin.deletePreReceiveHook({ pre_receive_hook_id }); -octokit.enterpriseAdmin.deletePublicKey({ key_ids }); -octokit.enterpriseAdmin.deleteUser({ username }); -octokit.enterpriseAdmin.demoteSiteAdministrator({ username }); -octokit.enterpriseAdmin.disableSelectedOrganizationGithubActionsEnterprise({ - enterprise, - org_id, -}); -octokit.enterpriseAdmin.enableOrDisableMaintenanceMode({ maintenance, origin }); -octokit.enterpriseAdmin.enableSelectedOrganizationGithubActionsEnterprise({ - enterprise, - org_id, -}); -octokit.enterpriseAdmin.getAllAuthorizedSshKeys({ origin }); -octokit.enterpriseAdmin.getAllStats(); -octokit.enterpriseAdmin.getAllowedActionsEnterprise({ enterprise }); -octokit.enterpriseAdmin.getAnnouncement(); -octokit.enterpriseAdmin.getCommentStats(); -octokit.enterpriseAdmin.getConfigurationStatus({ origin }); -octokit.enterpriseAdmin.getDownloadStatusForPreReceiveEnvironment({ - pre_receive_environment_id, -}); -octokit.enterpriseAdmin.getGistStats(); -octokit.enterpriseAdmin.getGithubActionsPermissionsEnterprise({ enterprise }); -octokit.enterpriseAdmin.getGlobalWebhook({ hook_id }); -octokit.enterpriseAdmin.getHooksStats(); -octokit.enterpriseAdmin.getIssueStats(); -octokit.enterpriseAdmin.getLicenseInformation(); -octokit.enterpriseAdmin.getMaintenanceStatus({ origin }); -octokit.enterpriseAdmin.getMilestoneStats(); -octokit.enterpriseAdmin.getOrgStats(); -octokit.enterpriseAdmin.getPagesStats(); -octokit.enterpriseAdmin.getPreReceiveEnvironment({ - pre_receive_environment_id, -}); -octokit.enterpriseAdmin.getPreReceiveHook({ pre_receive_hook_id }); -octokit.enterpriseAdmin.getPreReceiveHookForOrg({ org, pre_receive_hook_id }); -octokit.enterpriseAdmin.getPreReceiveHookForRepo({ - owner, - repo, - pre_receive_hook_id, -}); -octokit.enterpriseAdmin.getPullRequestStats(); -octokit.enterpriseAdmin.getRepoStats(); -octokit.enterpriseAdmin.getSettings({ origin }); -octokit.enterpriseAdmin.getUserStats(); -octokit.enterpriseAdmin.listGlobalWebhooks({ per_page, page }); -octokit.enterpriseAdmin.listPersonalAccessTokens({ per_page, page }); -octokit.enterpriseAdmin.listPreReceiveEnvironments({ - per_page, - page, - direction, - sort, -}); -octokit.enterpriseAdmin.listPreReceiveHooks({ - per_page, - page, - direction, - sort, -}); -octokit.enterpriseAdmin.listPreReceiveHooksForOrg({ - org, - per_page, - page, - direction, - sort, -}); -octokit.enterpriseAdmin.listPreReceiveHooksForRepo({ - owner, - repo, - per_page, - page, - direction, - sort, -}); -octokit.enterpriseAdmin.listPublicKeys({ - per_page, - page, - direction, - sort, - since, -}); -octokit.enterpriseAdmin.listSelectedOrganizationsEnabledGithubActionsEnterprise( - { enterprise, per_page, page } -); -octokit.enterpriseAdmin.pingGlobalWebhook({ hook_id }); -octokit.enterpriseAdmin.promoteUserToBeSiteAdministrator({ username }); -octokit.enterpriseAdmin.removeAnnouncement(); -octokit.enterpriseAdmin.removeAuthorizedSshKey({ authorized_key, origin }); -octokit.enterpriseAdmin.removePreReceiveHookEnforcementForOrg({ - org, - pre_receive_hook_id, -}); -octokit.enterpriseAdmin.removePreReceiveHookEnforcementForRepo({ - owner, - repo, - pre_receive_hook_id, -}); -octokit.enterpriseAdmin.setAllowedActionsEnterprise({ - enterprise, - github_owned_allowed, - patterns_allowed, -}); -octokit.enterpriseAdmin.setAnnouncement({ announcement, expires_at }); -octokit.enterpriseAdmin.setGithubActionsPermissionsEnterprise({ - enterprise, - enabled_organizations, - allowed_actions, -}); -octokit.enterpriseAdmin.setSelectedOrganizationsEnabledGithubActionsEnterprise({ - enterprise, - selected_organization_ids, -}); -octokit.enterpriseAdmin.setSettings({ settings, origin }); -octokit.enterpriseAdmin.startConfigurationProcess({ origin }); -octokit.enterpriseAdmin.startPreReceiveEnvironmentDownload({ - pre_receive_environment_id, -}); -octokit.enterpriseAdmin.suspendUser({ username, reason }); -octokit.enterpriseAdmin.syncLdapMappingForTeam({ team_id }); -octokit.enterpriseAdmin.syncLdapMappingForUser({ username }); -octokit.enterpriseAdmin.unsuspendUser({ username, reason }); -octokit.enterpriseAdmin.updateGlobalWebhook({ - hook_id, - config, - events, - active, -}); -octokit.enterpriseAdmin.updateLdapMappingForTeam({ team_id, ldap_dn }); -octokit.enterpriseAdmin.updateLdapMappingForUser({ username, ldap_dn }); -octokit.enterpriseAdmin.updateOrgName({ org, login }); -octokit.enterpriseAdmin.updatePreReceiveEnvironment({ - pre_receive_environment_id, - name, - image_url, -}); -octokit.enterpriseAdmin.updatePreReceiveHook({ - pre_receive_hook_id, - name, - script, - script_repository, - environment, - enforcement, - allow_downstream_configuration, -}); -octokit.enterpriseAdmin.updatePreReceiveHookEnforcementForOrg({ - org, - pre_receive_hook_id, - enforcement, - allow_downstream_configuration, -}); -octokit.enterpriseAdmin.updatePreReceiveHookEnforcementForRepo({ - owner, - repo, - pre_receive_hook_id, - enforcement, -}); -octokit.enterpriseAdmin.updateUsernameForUser({ username, login }); -octokit.enterpriseAdmin.upgradeLicense({ license, origin }); -``` - - - -## Others - -```js -octokit.actions.addSelectedRepoToOrgSecret({org, secret_name, repository_id}); -octokit.actions.cancelWorkflowRun({owner, repo, run_id}); -octokit.actions.createOrUpdateEnvironmentSecret({repository_id, environment_name, secret_name, encrypted_value, key_id}); -octokit.actions.createOrUpdateOrgSecret({org, secret_name, encrypted_value, key_id, visibility, selected_repository_ids}); -octokit.actions.createOrUpdateRepoSecret({owner, repo, secret_name, encrypted_value, key_id}); -octokit.actions.createRegistrationTokenForOrg({org}); -octokit.actions.createRegistrationTokenForRepo({owner, repo}); -octokit.actions.createRemoveTokenForOrg({org}); -octokit.actions.createRemoveTokenForRepo({owner, repo}); -octokit.actions.createWorkflowDispatch({owner, repo, workflow_id, ref, inputs}); -octokit.actions.deleteArtifact({owner, repo, artifact_id}); -octokit.actions.deleteEnvironmentSecret({repository_id, environment_name, secret_name}); -octokit.actions.deleteOrgSecret({org, secret_name}); -octokit.actions.deleteRepoSecret({owner, repo, secret_name}); -octokit.actions.deleteSelfHostedRunnerFromOrg({org, runner_id}); -octokit.actions.deleteSelfHostedRunnerFromRepo({owner, repo, runner_id}); -octokit.actions.deleteWorkflowRun({owner, repo, run_id}); -octokit.actions.deleteWorkflowRunLogs({owner, repo, run_id}); -octokit.actions.disableSelectedRepositoryGithubActionsOrganization({org, repository_id}); -octokit.actions.disableWorkflow({owner, repo, workflow_id}); -octokit.actions.downloadArtifact({owner, repo, artifact_id, archive_format}); -octokit.actions.downloadJobLogsForWorkflowRun({owner, repo, job_id}); -octokit.actions.downloadWorkflowRunLogs({owner, repo, run_id}); -octokit.actions.enableSelectedRepositoryGithubActionsOrganization({org, repository_id}); -octokit.actions.enableWorkflow({owner, repo, workflow_id}); -octokit.actions.getAllowedActionsOrganization({org}); -octokit.actions.getAllowedActionsRepository({owner, repo}); -octokit.actions.getArtifact({owner, repo, artifact_id}); -octokit.actions.getEnvironmentPublicKey({repository_id, environment_name}); -octokit.actions.getEnvironmentSecret({repository_id, environment_name, secret_name}); -octokit.actions.getGithubActionsPermissionsOrganization({org}); -octokit.actions.getGithubActionsPermissionsRepository({owner, repo}); -octokit.actions.getJobForWorkflowRun({owner, repo, job_id}); -octokit.actions.getOrgPublicKey({org}); -octokit.actions.getOrgSecret({org, secret_name}); -octokit.actions.getPendingDeploymentsForRun({owner, repo, run_id}); -octokit.actions.getRepoPublicKey({owner, repo}); -octokit.actions.getRepoSecret({owner, repo, secret_name}); -octokit.actions.getReviewsForRun({owner, repo, run_id}); -octokit.actions.getSelfHostedRunnerForOrg({org, runner_id}); -octokit.actions.getSelfHostedRunnerForRepo({owner, repo, runner_id}); -octokit.actions.getWorkflow({owner, repo, workflow_id}); -octokit.actions.getWorkflowRun({owner, repo, run_id, exclude_pull_requests}); -octokit.actions.listArtifactsForRepo({owner, repo, per_page, page}); -octokit.actions.listEnvironmentSecrets({repository_id, environment_name, per_page, page}); -octokit.actions.listJobsForWorkflowRun({owner, repo, run_id, filter, per_page, page}); -octokit.actions.listOrgSecrets({org, per_page, page}); -octokit.actions.listRepoSecrets({owner, repo, per_page, page}); -octokit.actions.listRepoWorkflows({owner, repo, per_page, page}); -octokit.actions.listRunnerApplicationsForOrg({org}); -octokit.actions.listRunnerApplicationsForRepo({owner, repo}); -octokit.actions.listSelectedReposForOrgSecret({org, secret_name, page, per_page}); -octokit.actions.listSelectedRepositoriesEnabledGithubActionsOrganization({org, per_page, page}); -octokit.actions.listSelfHostedRunnersForOrg({org, per_page, page}); -octokit.actions.listSelfHostedRunnersForRepo({owner, repo, per_page, page}); -octokit.actions.listWorkflowRunArtifacts({owner, repo, run_id, per_page, page}); -octokit.actions.listWorkflowRuns({owner, repo, workflow_id, actor, branch, event, status, per_page, page, created, exclude_pull_requests}); -octokit.actions.listWorkflowRunsForRepo({owner, repo, actor, branch, event, status, per_page, page, created, exclude_pull_requests}); -octokit.actions.reRunWorkflow({owner, repo, run_id}); -octokit.actions.removeSelectedRepoFromOrgSecret({org, secret_name, repository_id}); -octokit.actions.reviewPendingDeploymentsForRun({owner, repo, run_id, environment_ids, state, comment}); -octokit.actions.setAllowedActionsOrganization({org, github_owned_allowed, patterns_allowed}); -octokit.actions.setAllowedActionsRepository({owner, repo, github_owned_allowed, patterns_allowed}); -octokit.actions.setGithubActionsPermissionsOrganization({org, enabled_repositories, allowed_actions}); -octokit.actions.setGithubActionsPermissionsRepository({owner, repo, enabled, allowed_actions}); -octokit.actions.setSelectedReposForOrgSecret({org, secret_name, selected_repository_ids}); -octokit.actions.setSelectedRepositoriesEnabledGithubActionsOrganization({org, selected_repository_ids}); -octokit.activity.checkRepoIsStarredByAuthenticatedUser({owner, repo}); -octokit.activity.deleteRepoSubscription({owner, repo}); -octokit.activity.deleteThreadSubscription({thread_id}); -octokit.activity.getFeeds(); -octokit.activity.getRepoSubscription({owner, repo}); -octokit.activity.getThread({thread_id}); -octokit.activity.getThreadSubscriptionForAuthenticatedUser({thread_id}); -octokit.activity.listEventsForAuthenticatedUser({username, per_page, page}); -octokit.activity.listNotificationsForAuthenticatedUser({all, participating, since, before, page, per_page}); -octokit.activity.listOrgEventsForAuthenticatedUser({username, org, per_page, page}); -octokit.activity.listPublicEvents({per_page, page}); -octokit.activity.listPublicEventsForRepoNetwork({owner, repo, per_page, page}); -octokit.activity.listPublicEventsForUser({username, per_page, page}); -octokit.activity.listPublicOrgEvents({org, per_page, page}); -octokit.activity.listReceivedEventsForUser({username, per_page, page}); -octokit.activity.listReceivedPublicEventsForUser({username, per_page, page}); -octokit.activity.listRepoEvents({owner, repo, per_page, page}); -octokit.activity.listRepoNotificationsForAuthenticatedUser({owner, repo, all, participating, since, before, per_page, page}); -octokit.activity.listReposStarredByAuthenticatedUser({sort, direction, per_page, page}); -octokit.activity.listReposStarredByUser({username, sort, direction, per_page, page}); -octokit.activity.listReposWatchedByUser({username, per_page, page}); -octokit.activity.listStargazersForRepo({owner, repo, per_page, page}); -octokit.activity.listWatchedReposForAuthenticatedUser({per_page, page}); -octokit.activity.listWatchersForRepo({owner, repo, per_page, page}); -octokit.activity.markNotificationsAsRead({last_read_at, read}); -octokit.activity.markRepoNotificationsAsRead({owner, repo, last_read_at}); -octokit.activity.markThreadAsRead({thread_id}); -octokit.activity.setRepoSubscription({owner, repo, subscribed, ignored}); -octokit.activity.setThreadSubscription({thread_id, ignored}); -octokit.activity.starRepoForAuthenticatedUser({owner, repo}); -octokit.activity.unstarRepoForAuthenticatedUser({owner, repo}); -octokit.apps.addRepoToInstallation({installation_id, repository_id}); -octokit.apps.addRepoToInstallationForAuthenticatedUser({installation_id, repository_id}); -octokit.apps.checkAuthorization({client_id, access_token}); -octokit.apps.checkToken({client_id, access_token}); -octokit.apps.createContentAttachment({content_reference_id, title, body}); -octokit.apps.createContentAttachmentForRepo({owner, repo, content_reference_id, title, body}); -octokit.apps.createFromManifest({code}); -octokit.apps.createInstallationAccessToken({installation_id, repositories, repository_ids, permissions}); -octokit.apps.deleteAuthorization({client_id, access_token}); -octokit.apps.deleteInstallation({installation_id}); -octokit.apps.deleteToken({client_id, access_token}); -octokit.apps.getAuthenticated(); -octokit.apps.getBySlug({app_slug}); -octokit.apps.getInstallation({installation_id}); -octokit.apps.getOrgInstallation({org}); -octokit.apps.getRepoInstallation({owner, repo}); -octokit.apps.getUserInstallation({username}); -octokit.apps.getWebhookConfigForApp(); -octokit.apps.getWebhookDelivery({delivery_id}); -octokit.apps.listInstallationReposForAuthenticatedUser({installation_id, per_page, page}); -octokit.apps.listInstallations({per_page, page, since, outdated}); -octokit.apps.listInstallationsForAuthenticatedUser({per_page, page}); -octokit.apps.listReposAccessibleToInstallation({per_page, page}); -octokit.apps.listWebhookDeliveries({per_page, cursor}); -octokit.apps.redeliverWebhookDelivery({delivery_id}); -octokit.apps.removeRepoFromInstallation({installation_id, repository_id}); -octokit.apps.removeRepoFromInstallationForAuthenticatedUser({installation_id, repository_id}); -octokit.apps.resetAuthorization({client_id, access_token}); -octokit.apps.resetToken({client_id, access_token}); -octokit.apps.revokeAuthorizationForApplication({client_id, access_token}); -octokit.apps.revokeGrantForApplication({client_id, access_token}); -octokit.apps.revokeInstallationAccessToken(); -octokit.apps.scopeToken({client_id, access_token, target, target_id, repositories, repository_ids, permissions}); -octokit.apps.suspendInstallation({installation_id}); -octokit.apps.unsuspendInstallation({installation_id}); -octokit.apps.updateWebhookConfigForApp({url, content_type, secret, insecure_ssl}); -octokit.checks.create({owner, repo, status, *}); -octokit.checks.createSuite({owner, repo, head_sha}); -octokit.checks.get({owner, repo, check_run_id}); -octokit.checks.getSuite({owner, repo, check_suite_id}); -octokit.checks.listAnnotations({owner, repo, check_run_id, per_page, page}); -octokit.checks.listForRef({owner, repo, ref, check_name, status, filter, per_page, page, app_id}); -octokit.checks.listForSuite({owner, repo, check_suite_id, check_name, status, filter, per_page, page}); -octokit.checks.listSuitesForRef({owner, repo, ref, app_id, check_name, per_page, page}); -octokit.checks.rerequestRun({owner, repo, check_run_id}); -octokit.checks.rerequestSuite({owner, repo, check_suite_id}); -octokit.checks.setSuitesPreferences({owner, repo, auto_trigger_checks}); -octokit.checks.update({owner, repo, check_run_id, name, details_url, external_id, started_at, status, conclusion, completed_at, output, actions}); -octokit.codeScanning.deleteAnalysis({owner, repo, analysis_id, confirm_delete}); -octokit.codeScanning.getAlert({owner, repo, alert_number}); -octokit.codeScanning.getAnalysis({owner, repo, analysis_id}); -octokit.codeScanning.getSarif({owner, repo, sarif_id}); -octokit.codeScanning.listAlertInstances({owner, repo, alert_number, page, per_page, ref}); -octokit.codeScanning.listAlertsForRepo({owner, repo, tool_name, tool_guid, page, per_page, ref, state}); -octokit.codeScanning.listAlertsInstances({owner, repo, alert_number, page, per_page, ref}); -octokit.codeScanning.listRecentAnalyses({owner, repo, tool_name, tool_guid, page, per_page, ref, sarif_id}); -octokit.codeScanning.updateAlert({owner, repo, alert_number, state, dismissed_reason}); -octokit.codeScanning.uploadSarif({owner, repo, commit_sha, ref, sarif, checkout_uri, started_at, tool_name}); -octokit.codesOfConduct.getAllCodesOfConduct(); -octokit.codesOfConduct.getConductCode({key}); -octokit.codesOfConduct.getForRepo({owner, repo}); -octokit.emojis.get(); -octokit.gists.checkIsStarred({gist_id}); -octokit.gists.create({description, files, public}); -octokit.gists.createComment({gist_id, body}); -octokit.gists.delete({gist_id}); -octokit.gists.deleteComment({gist_id, comment_id}); -octokit.gists.fork({gist_id}); -octokit.gists.get({gist_id}); -octokit.gists.getComment({gist_id, comment_id}); -octokit.gists.getRevision({gist_id, sha}); -octokit.gists.list({since, per_page, page}); -octokit.gists.listComments({gist_id, per_page, page}); -octokit.gists.listCommits({gist_id, per_page, page}); -octokit.gists.listForUser({username, since, per_page, page}); -octokit.gists.listForks({gist_id, per_page, page}); -octokit.gists.listPublic({since, per_page, page}); -octokit.gists.listStarred({since, per_page, page}); -octokit.gists.star({gist_id}); -octokit.gists.unstar({gist_id}); -octokit.gists.update({gist_id, description, files}); -octokit.gists.updateComment({gist_id, comment_id, body}); -octokit.git.createBlob({owner, repo, content, encoding}); -octokit.git.createCommit({owner, repo, message, tree, parents, author, committer, signature}); -octokit.git.createRef({owner, repo, ref, sha, key}); -octokit.git.createTag({owner, repo, tag, message, object, type, tagger}); -octokit.git.createTree({owner, repo, tree, base_tree}); -octokit.git.deleteRef({owner, repo, ref}); -octokit.git.getBlob({owner, repo, file_sha}); -octokit.git.getCommit({owner, repo, commit_sha}); -octokit.git.getRef({owner, repo, ref}); -octokit.git.getTag({owner, repo, tag_sha}); -octokit.git.getTree({owner, repo, tree_sha, recursive}); -octokit.git.listMatchingRefs({owner, repo, ref}); -octokit.git.updateRef({owner, repo, ref, sha, force}); -octokit.gitignore.getAllTemplates(); -octokit.gitignore.getTemplate({name}); -octokit.issues.addAssignees({owner, repo, issue_number, assignees}); -octokit.issues.addLabels({owner, repo, issue_number, labels}); -octokit.issues.checkUserCanBeAssigned({owner, repo, assignee}); -octokit.issues.create({owner, repo, title, body, assignee, milestone, labels, assignees}); -octokit.issues.createComment({owner, repo, issue_number, body}); -octokit.issues.createLabel({owner, repo, name, color, description}); -octokit.issues.createMilestone({owner, repo, title, state, description, due_on}); -octokit.issues.deleteComment({owner, repo, comment_id}); -octokit.issues.deleteLabel({owner, repo, name}); -octokit.issues.deleteMilestone({owner, repo, milestone_number}); -octokit.issues.get({owner, repo, issue_number}); -octokit.issues.getComment({owner, repo, comment_id}); -octokit.issues.getEvent({owner, repo, event_id}); -octokit.issues.getLabel({owner, repo, name}); -octokit.issues.getMilestone({owner, repo, milestone_number}); -octokit.issues.list({filter, state, labels, sort, direction, since, collab, orgs, owned, pulls, per_page, page}); -octokit.issues.listAssignees({owner, repo, per_page, page}); -octokit.issues.listComments({owner, repo, issue_number, since, per_page, page}); -octokit.issues.listCommentsForRepo({owner, repo, sort, direction, since, per_page, page}); -octokit.issues.listEvents({owner, repo, issue_number, per_page, page}); -octokit.issues.listEventsForRepo({owner, repo, per_page, page}); -octokit.issues.listEventsForTimeline({owner, repo, issue_number, per_page, page}); -octokit.issues.listForAuthenticatedUser({filter, state, labels, sort, direction, since, per_page, page}); -octokit.issues.listForOrg({org, filter, state, labels, sort, direction, since, per_page, page}); -octokit.issues.listForRepo({owner, repo, milestone, state, assignee, creator, mentioned, labels, sort, direction, since, per_page, page}); -octokit.issues.listLabelsForMilestone({owner, repo, milestone_number, per_page, page}); -octokit.issues.listLabelsForRepo({owner, repo, per_page, page}); -octokit.issues.listLabelsOnIssue({owner, repo, issue_number, per_page, page}); -octokit.issues.listMilestones({owner, repo, state, sort, direction, per_page, page}); -octokit.issues.lock({owner, repo, issue_number, lock_reason}); -octokit.issues.removeAllLabels({owner, repo, issue_number}); -octokit.issues.removeAssignees({owner, repo, issue_number, assignees}); -octokit.issues.removeLabel({owner, repo, issue_number, name}); -octokit.issues.setLabels({owner, repo, issue_number, labels}); -octokit.issues.unlock({owner, repo, issue_number}); -octokit.issues.update({owner, repo, issue_number, title, body, assignee, state, state_reason, milestone, labels, assignees}); -octokit.issues.updateComment({owner, repo, comment_id, body}); -octokit.issues.updateLabel({owner, repo, name, new_name, color, description}); -octokit.issues.updateMilestone({owner, repo, milestone_number, title, state, description, due_on}); -octokit.licenses.get({license}); -octokit.licenses.getAllCommonlyUsed({featured, per_page, page}); -octokit.licenses.getForRepo({owner, repo}); -octokit.markdown.render({text, mode, context}); -octokit.markdown.renderRaw({data}); -octokit.meta.get(); -octokit.meta.getOctocat({s}); -octokit.meta.getZen(); -octokit.meta.root(); -octokit.orgs.checkMembershipForUser({org, username}); -octokit.orgs.checkPublicMembershipForUser({org, username}); -octokit.orgs.convertMemberToOutsideCollaborator({org, username, async}); -octokit.orgs.createWebhook({org, name, config, events, active}); -octokit.orgs.deleteWebhook({org, hook_id}); -octokit.orgs.get({org}); -octokit.orgs.getMembershipForAuthenticatedUser({org}); -octokit.orgs.getMembershipForUser({org, username}); -octokit.orgs.getWebhook({org, hook_id}); -octokit.orgs.getWebhookConfigForOrg({org, hook_id}); -octokit.orgs.getWebhookDelivery({org, hook_id, delivery_id}); -octokit.orgs.list({since, per_page}); -octokit.orgs.listAppInstallations({org, per_page, page}); -octokit.orgs.listForAuthenticatedUser({per_page, page}); -octokit.orgs.listForUser({username, per_page, page}); -octokit.orgs.listMembers({org, filter, role, per_page, page}); -octokit.orgs.listMembershipsForAuthenticatedUser({state, per_page, page}); -octokit.orgs.listOutsideCollaborators({org, filter, per_page, page}); -octokit.orgs.listPublicMembers({org, per_page, page}); -octokit.orgs.listWebhookDeliveries({org, hook_id, per_page, cursor}); -octokit.orgs.listWebhooks({org, per_page, page}); -octokit.orgs.pingWebhook({org, hook_id}); -octokit.orgs.redeliverWebhookDelivery({org, hook_id, delivery_id}); -octokit.orgs.removeMember({org, username}); -octokit.orgs.removeMembershipForUser({org, username}); -octokit.orgs.removeOutsideCollaborator({org, username}); -octokit.orgs.removePublicMembershipForAuthenticatedUser({org, username}); -octokit.orgs.setMembershipForUser({org, username, role}); -octokit.orgs.setPublicMembershipForAuthenticatedUser({org, username}); -octokit.orgs.update({org, billing_email, company, email, twitter_username, location, name, description, has_organization_projects, has_repository_projects, default_repository_permission, members_can_create_repositories, members_can_create_internal_repositories, members_can_create_private_repositories, members_can_create_public_repositories, members_allowed_repository_creation_type, members_can_create_pages, blog}); -octokit.orgs.updateMembershipForAuthenticatedUser({org, state}); -octokit.orgs.updateWebhook({org, hook_id, config, events, active, name}); -octokit.orgs.updateWebhookConfigForOrg({org, hook_id, url, content_type, secret, insecure_ssl}); -octokit.projects.addCollaborator({project_id, username, permission}); -octokit.projects.createCard({column_id, note, content_id, content_type}); -octokit.projects.createColumn({project_id, name}); -octokit.projects.createForAuthenticatedUser({name, body}); -octokit.projects.createForOrg({org, name, body}); -octokit.projects.createForRepo({owner, repo, name, body}); -octokit.projects.delete({project_id}); -octokit.projects.deleteCard({card_id}); -octokit.projects.deleteColumn({column_id}); -octokit.projects.get({project_id}); -octokit.projects.getCard({card_id}); -octokit.projects.getColumn({column_id}); -octokit.projects.getPermissionForUser({project_id, username}); -octokit.projects.listCards({column_id, archived_state, per_page, page}); -octokit.projects.listCollaborators({project_id, affiliation, per_page, page}); -octokit.projects.listColumns({project_id, per_page, page}); -octokit.projects.listForOrg({org, state, per_page, page}); -octokit.projects.listForRepo({owner, repo, state, per_page, page}); -octokit.projects.listForUser({username, state, per_page, page}); -octokit.projects.moveCard({card_id, position, column_id}); -octokit.projects.moveColumn({column_id, position}); -octokit.projects.removeCollaborator({project_id, username}); -octokit.projects.update({project_id, name, body, state, organization_permission, private}); -octokit.projects.updateCard({card_id, note, archived}); -octokit.projects.updateColumn({column_id, name}); -octokit.pulls.checkIfMerged({owner, repo, pull_number}); -octokit.pulls.create({owner, repo, title, head, base, body, maintainer_can_modify, draft, issue}); -octokit.pulls.createReplyForReviewComment({owner, repo, pull_number, comment_id, body}); -octokit.pulls.createReview({owner, repo, pull_number, commit_id, body, event, comments}); -octokit.pulls.createReviewComment({owner, repo, pull_number, body, commit_id, path, position, side, line, start_line, start_side, in_reply_to}); -octokit.pulls.deletePendingReview({owner, repo, pull_number, review_id}); -octokit.pulls.deleteReviewComment({owner, repo, comment_id}); -octokit.pulls.dismissReview({owner, repo, pull_number, review_id, message, event}); -octokit.pulls.get({owner, repo, pull_number}); -octokit.pulls.getReview({owner, repo, pull_number, review_id}); -octokit.pulls.getReviewComment({owner, repo, comment_id}); -octokit.pulls.list({owner, repo, state, head, base, sort, direction, per_page, page}); -octokit.pulls.listCommentsForReview({owner, repo, pull_number, review_id, per_page, page}); -octokit.pulls.listCommits({owner, repo, pull_number, per_page, page}); -octokit.pulls.listFiles({owner, repo, pull_number, per_page, page}); -octokit.pulls.listRequestedReviewers({owner, repo, pull_number}); -octokit.pulls.listReviewComments({owner, repo, pull_number, sort, direction, since, per_page, page}); -octokit.pulls.listReviewCommentsForRepo({owner, repo, sort, direction, since, per_page, page}); -octokit.pulls.listReviews({owner, repo, pull_number, per_page, page}); -octokit.pulls.merge({owner, repo, pull_number, commit_title, commit_message, sha, merge_method}); -octokit.pulls.removeRequestedReviewers({owner, repo, pull_number, reviewers, team_reviewers}); -octokit.pulls.requestReviewers({owner, repo, pull_number, reviewers, team_reviewers}); -octokit.pulls.submitReview({owner, repo, pull_number, review_id, body, event}); -octokit.pulls.update({owner, repo, pull_number, title, body, state, base, maintainer_can_modify}); -octokit.pulls.updateBranch({owner, repo, pull_number, expected_head_sha}); -octokit.pulls.updateReview({owner, repo, pull_number, review_id, body}); -octokit.pulls.updateReviewComment({owner, repo, comment_id, body}); -octokit.rateLimit.get(); -octokit.reactions.createForCommitComment({owner, repo, comment_id, content}); -octokit.reactions.createForIssue({owner, repo, issue_number, content}); -octokit.reactions.createForIssueComment({owner, repo, comment_id, content}); -octokit.reactions.createForPullRequestReviewComment({owner, repo, comment_id, content}); -octokit.reactions.createForRelease({owner, repo, release_id, content}); -octokit.reactions.createForTeamDiscussionCommentInOrg({org, team_slug, discussion_number, comment_number, content}); -octokit.reactions.createForTeamDiscussionCommentLegacy({team_id, discussion_number, comment_number, content}); -octokit.reactions.createForTeamDiscussionInOrg({org, team_slug, discussion_number, content}); -octokit.reactions.createForTeamDiscussionLegacy({team_id, discussion_number, content}); -octokit.reactions.deleteForCommitComment({owner, repo, comment_id, reaction_id}); -octokit.reactions.deleteForIssue({owner, repo, issue_number, reaction_id}); -octokit.reactions.deleteForIssueComment({owner, repo, comment_id, reaction_id}); -octokit.reactions.deleteForPullRequestComment({owner, repo, comment_id, reaction_id}); -octokit.reactions.deleteForRelease({owner, repo, release_id, reaction_id}); -octokit.reactions.deleteForTeamDiscussion({org, team_slug, discussion_number, reaction_id}); -octokit.reactions.deleteForTeamDiscussionComment({org, team_slug, discussion_number, comment_number, reaction_id}); -octokit.reactions.deleteLegacy({reaction_id}); -octokit.reactions.listForCommitComment({owner, repo, comment_id, content, per_page, page}); -octokit.reactions.listForIssue({owner, repo, issue_number, content, per_page, page}); -octokit.reactions.listForIssueComment({owner, repo, comment_id, content, per_page, page}); -octokit.reactions.listForPullRequestReviewComment({owner, repo, comment_id, content, per_page, page}); -octokit.reactions.listForRelease({owner, repo, release_id, content, per_page, page}); -octokit.reactions.listForTeamDiscussionCommentInOrg({org, team_slug, discussion_number, comment_number, content, per_page, page}); -octokit.reactions.listForTeamDiscussionCommentLegacy({team_id, discussion_number, comment_number, content, per_page, page}); -octokit.reactions.listForTeamDiscussionInOrg({org, team_slug, discussion_number, content, per_page, page}); -octokit.reactions.listForTeamDiscussionLegacy({team_id, discussion_number, content, per_page, page}); -octokit.repos.acceptInvitation({invitation_id}); -octokit.repos.acceptInvitationForAuthenticatedUser({invitation_id}); -octokit.repos.addAppAccessRestrictions({owner, repo, branch, apps}); -octokit.repos.addCollaborator({owner, repo, username, permission}); -octokit.repos.addStatusCheckContexts({owner, repo, branch, contexts}); -octokit.repos.addTeamAccessRestrictions({owner, repo, branch, teams}); -octokit.repos.addUserAccessRestrictions({owner, repo, branch, users}); -octokit.repos.checkCollaborator({owner, repo, username}); -octokit.repos.compareCommits({owner, repo, base, head, per_page, page}); -octokit.repos.compareCommitsWithBasehead({owner, repo, page, per_page, basehead}); -octokit.repos.createAutolink({owner, repo, key_prefix, url_template, is_alphanumeric}); -octokit.repos.createCommitComment({owner, repo, commit_sha, body, path, position, line}); -octokit.repos.createCommitSignatureProtection({owner, repo, branch}); -octokit.repos.createCommitStatus({owner, repo, sha, state, target_url, description, context}); -octokit.repos.createDeployKey({owner, repo, title, key, read_only}); -octokit.repos.createDeployment({owner, repo, ref, task, auto_merge, required_contexts, payload, environment, description, transient_environment, production_environment}); -octokit.repos.createDeploymentBranchPolicy({owner, repo, environment_name, name}); -octokit.repos.createDeploymentStatus({owner, repo, deployment_id, state, target_url, log_url, description, environment, environment_url, auto_inactive}); -octokit.repos.createDispatchEvent({owner, repo, event_type, client_payload}); -octokit.repos.createForAuthenticatedUser({name, description, homepage, private, has_issues, has_projects, has_wiki, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, has_downloads, is_template}); -octokit.repos.createFork({owner, repo, organization}); -octokit.repos.createInOrg({org, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, is_template, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message}); -octokit.repos.createOrUpdateEnvironment({owner, repo, environment_name, wait_timer, reviewers, deployment_branch_policy}); -octokit.repos.createOrUpdateFileContents({owner, repo, path, message, content, sha, branch, committer, author}); -octokit.repos.createPagesSite({owner, repo, build_type, source}); -octokit.repos.createRelease({owner, repo, tag_name, target_commitish, name, body, draft, prerelease, generate_release_notes}); -octokit.repos.createUsingTemplate({template_owner, template_repo, owner, name, description, include_all_branches, private}); -octokit.repos.createWebhook({owner, repo, name, config, events, active}); -octokit.repos.declineInvitation({invitation_id}); -octokit.repos.declineInvitationForAuthenticatedUser({invitation_id}); -octokit.repos.delete({owner, repo}); -octokit.repos.deleteAccessRestrictions({owner, repo, branch}); -octokit.repos.deleteAdminBranchProtection({owner, repo, branch}); -octokit.repos.deleteAnEnvironment({owner, repo, environment_name}); -octokit.repos.deleteAutolink({owner, repo, autolink_id}); -octokit.repos.deleteBranchProtection({owner, repo, branch}); -octokit.repos.deleteCommitComment({owner, repo, comment_id}); -octokit.repos.deleteCommitSignatureProtection({owner, repo, branch}); -octokit.repos.deleteDeployKey({owner, repo, key_id}); -octokit.repos.deleteDeployment({owner, repo, deployment_id}); -octokit.repos.deleteDeploymentBranchPolicy({owner, repo, environment_name, branch_policy_id}); -octokit.repos.deleteFile({owner, repo, path, message, sha, branch, committer, author}); -octokit.repos.deleteInvitation({owner, repo, invitation_id}); -octokit.repos.deletePagesSite({owner, repo}); -octokit.repos.deletePullRequestReviewProtection({owner, repo, branch}); -octokit.repos.deleteRelease({owner, repo, release_id}); -octokit.repos.deleteReleaseAsset({owner, repo, asset_id}); -octokit.repos.deleteWebhook({owner, repo, hook_id}); -octokit.repos.disableLfsForRepo({owner, repo}); -octokit.repos.downloadTarballArchive({owner, repo, ref}); -octokit.repos.downloadZipballArchive({owner, repo, ref}); -octokit.repos.enableLfsForRepo({owner, repo}); -octokit.repos.generateReleaseNotes({owner, repo, tag_name, target_commitish, previous_tag_name, configuration_file_path}); -octokit.repos.get({owner, repo}); -octokit.repos.getAccessRestrictions({owner, repo, branch}); -octokit.repos.getAdminBranchProtection({owner, repo, branch}); -octokit.repos.getAllEnvironments({owner, repo, per_page, page}); -octokit.repos.getAllStatusCheckContexts({owner, repo, branch}); -octokit.repos.getAllTopics({owner, repo, page, per_page}); -octokit.repos.getAppsWithAccessToProtectedBranch({owner, repo, branch}); -octokit.repos.getAutolink({owner, repo, autolink_id}); -octokit.repos.getBranch({owner, repo, branch}); -octokit.repos.getBranchProtection({owner, repo, branch}); -octokit.repos.getCodeFrequencyStats({owner, repo}); -octokit.repos.getCollaboratorPermissionLevel({owner, repo, username}); -octokit.repos.getCombinedStatusForRef({owner, repo, ref, per_page, page}); -octokit.repos.getCommit({owner, repo, page, per_page, ref}); -octokit.repos.getCommitActivityStats({owner, repo}); -octokit.repos.getCommitComment({owner, repo, comment_id}); -octokit.repos.getCommitSignatureProtection({owner, repo, branch}); -octokit.repos.getContent({owner, repo, path, ref}); -octokit.repos.getContributorsStats({owner, repo}); -octokit.repos.getDeployKey({owner, repo, key_id}); -octokit.repos.getDeployment({owner, repo, deployment_id}); -octokit.repos.getDeploymentBranchPolicy({owner, repo, environment_name, branch_policy_id}); -octokit.repos.getDeploymentStatus({owner, repo, deployment_id, status_id}); -octokit.repos.getEnvironment({owner, repo, environment_name}); -octokit.repos.getLatestPagesBuild({owner, repo}); -octokit.repos.getLatestRelease({owner, repo}); -octokit.repos.getPages({owner, repo}); -octokit.repos.getPagesBuild({owner, repo, build_id}); -octokit.repos.getParticipationStats({owner, repo}); -octokit.repos.getPullRequestReviewProtection({owner, repo, branch}); -octokit.repos.getPunchCardStats({owner, repo}); -octokit.repos.getReadme({owner, repo, ref}); -octokit.repos.getReadmeInDirectory({owner, repo, dir, ref}); -octokit.repos.getRelease({owner, repo, release_id}); -octokit.repos.getReleaseAsset({owner, repo, asset_id}); -octokit.repos.getReleaseByTag({owner, repo, tag}); -octokit.repos.getStatusChecksProtection({owner, repo, branch}); -octokit.repos.getTeamsWithAccessToProtectedBranch({owner, repo, branch}); -octokit.repos.getUsersWithAccessToProtectedBranch({owner, repo, branch}); -octokit.repos.getWebhook({owner, repo, hook_id}); -octokit.repos.getWebhookConfigForRepo({owner, repo, hook_id}); -octokit.repos.getWebhookDelivery({owner, repo, hook_id, delivery_id}); -octokit.repos.listAutolinks({owner, repo, page}); -octokit.repos.listBranches({owner, repo, protected, per_page, page}); -octokit.repos.listBranchesForHeadCommit({owner, repo, commit_sha}); -octokit.repos.listCollaborators({owner, repo, affiliation, permission, per_page, page}); -octokit.repos.listCommentsForCommit({owner, repo, commit_sha, per_page, page}); -octokit.repos.listCommitCommentsForRepo({owner, repo, per_page, page}); -octokit.repos.listCommitStatusesForRef({owner, repo, ref, per_page, page}); -octokit.repos.listCommits({owner, repo, sha, path, author, since, until, per_page, page}); -octokit.repos.listContributors({owner, repo, anon, per_page, page}); -octokit.repos.listDeployKeys({owner, repo, per_page, page}); -octokit.repos.listDeploymentBranchPolicies({owner, repo, environment_name, per_page, page}); -octokit.repos.listDeploymentStatuses({owner, repo, deployment_id, per_page, page}); -octokit.repos.listDeployments({owner, repo, sha, ref, task, environment, per_page, page}); -octokit.repos.listForAuthenticatedUser({visibility, affiliation, type, sort, direction, per_page, page, since, before}); -octokit.repos.listForOrg({org, type, sort, direction, per_page, page}); -octokit.repos.listForUser({username, type, sort, direction, per_page, page}); -octokit.repos.listForks({owner, repo, sort, per_page, page}); -octokit.repos.listInvitations({owner, repo, per_page, page}); -octokit.repos.listInvitationsForAuthenticatedUser({per_page, page}); -octokit.repos.listLanguages({owner, repo}); -octokit.repos.listPagesBuilds({owner, repo, per_page, page}); -octokit.repos.listPublic({since, visibility}); -octokit.repos.listPullRequestsAssociatedWithCommit({owner, repo, commit_sha, per_page, page}); -octokit.repos.listReleaseAssets({owner, repo, release_id, per_page, page}); -octokit.repos.listReleases({owner, repo, per_page, page}); -octokit.repos.listTags({owner, repo, per_page, page}); -octokit.repos.listTeams({owner, repo, per_page, page}); -octokit.repos.listWebhookDeliveries({owner, repo, hook_id, per_page, cursor}); -octokit.repos.listWebhooks({owner, repo, per_page, page}); -octokit.repos.merge({owner, repo, base, head, commit_message}); -octokit.repos.mergeUpstream({owner, repo, branch}); -octokit.repos.pingWebhook({owner, repo, hook_id}); -octokit.repos.redeliverWebhookDelivery({owner, repo, hook_id, delivery_id}); -octokit.repos.removeAppAccessRestrictions({owner, repo, branch, apps}); -octokit.repos.removeCollaborator({owner, repo, username}); -octokit.repos.removeStatusCheckContexts({owner, repo, branch, contexts}); -octokit.repos.removeStatusCheckProtection({owner, repo, branch}); -octokit.repos.removeTeamAccessRestrictions({owner, repo, branch, teams}); -octokit.repos.removeUserAccessRestrictions({owner, repo, branch, users}); -octokit.repos.renameBranch({owner, repo, branch, new_name}); -octokit.repos.replaceAllTopics({owner, repo, names}); -octokit.repos.requestPagesBuild({owner, repo}); -octokit.repos.setAdminBranchProtection({owner, repo, branch}); -octokit.repos.setAppAccessRestrictions({owner, repo, branch, apps}); -octokit.repos.setStatusCheckContexts({owner, repo, branch, contexts}); -octokit.repos.setTeamAccessRestrictions({owner, repo, branch, teams}); -octokit.repos.setUserAccessRestrictions({owner, repo, branch, users}); -octokit.repos.testPushWebhook({owner, repo, hook_id}); -octokit.repos.transfer({owner, repo, new_owner, team_ids}); -octokit.repos.update({owner, repo, name, description, homepage, private, visibility, security_and_analysis, has_issues, has_projects, has_wiki, is_template, default_branch, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, allow_update_branch, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, archived, allow_forking}); -octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions, block_creations, required_conversation_resolution, contexts}); -octokit.repos.updateCommitComment({owner, repo, comment_id, body}); -octokit.repos.updateDeploymentBranchPolicy({owner, repo, environment_name, branch_policy_id, name}); -octokit.repos.updateInformationAboutPagesSite({owner, repo, cname, https_enforced, public, build_type, source}); -octokit.repos.updateInvitation({owner, repo, invitation_id, permissions}); -octokit.repos.updatePullRequestReviewProtection({owner, repo, branch, dismissal_restrictions, dismiss_stale_reviews, require_code_owner_reviews, required_approving_review_count}); -octokit.repos.updateRelease({owner, repo, release_id, tag_name, target_commitish, name, body, draft, prerelease}); -octokit.repos.updateReleaseAsset({owner, repo, asset_id, name, label, state}); -octokit.repos.updateStatusCheckProtection({owner, repo, branch, strict, contexts}); -octokit.repos.updateWebhook({owner, repo, hook_id, config, events, add_events, remove_events, active}); -octokit.repos.updateWebhookConfigForRepo({owner, repo, hook_id, url, content_type, secret, insecure_ssl}); -octokit.repos.uploadReleaseAsset({owner, repo, release_id, name, label, data, origin}); -octokit.search.code({q, sort, order, per_page, page}); -octokit.search.commits({q, sort, order, per_page, page}); -octokit.search.issuesAndPullRequests({q, sort, order, per_page, page}); -octokit.search.labels({repository_id, q, sort, order, per_page, page}); -octokit.search.repos({q, sort, order, per_page, page}); -octokit.search.topics({q, per_page, page}); -octokit.search.users({q, sort, order, per_page, page}); -octokit.secretScanning.getAlert({owner, repo, alert_number}); -octokit.secretScanning.listAlertsForOrg({org, state, secret_type, resolution, page, per_page}); -octokit.secretScanning.listAlertsForRepo({owner, repo, state, secret_type, resolution, page, per_page}); -octokit.secretScanning.listLocationsForAlert({owner, repo, alert_number, page, per_page}); -octokit.secretScanning.updateAlert({owner, repo, alert_number, state, resolution}); -octokit.teams.addMemberLegacy({team_id, username}); -octokit.teams.addOrUpdateMembershipForUserInOrg({org, team_slug, username, role}); -octokit.teams.addOrUpdateMembershipForUserLegacy({team_id, username, role}); -octokit.teams.addOrUpdateProjectPermissionsInOrg({org, team_slug, project_id, permission}); -octokit.teams.addOrUpdateProjectPermissionsLegacy({team_id, project_id, permission}); -octokit.teams.addOrUpdateRepoPermissionsInOrg({org, team_slug, owner, repo, permission}); -octokit.teams.addOrUpdateRepoPermissionsLegacy({team_id, owner, repo, permission}); -octokit.teams.checkPermissionsForProjectInOrg({org, team_slug, project_id}); -octokit.teams.checkPermissionsForProjectLegacy({team_id, project_id}); -octokit.teams.checkPermissionsForRepoInOrg({org, team_slug, owner, repo}); -octokit.teams.checkPermissionsForRepoLegacy({team_id, owner, repo}); -octokit.teams.create({org, name, description, maintainers, repo_names, privacy, permission, parent_team_id, ldap_dn}); -octokit.teams.createDiscussionCommentInOrg({org, team_slug, discussion_number, body}); -octokit.teams.createDiscussionCommentLegacy({team_id, discussion_number, body}); -octokit.teams.createDiscussionInOrg({org, team_slug, title, body, private}); -octokit.teams.createDiscussionLegacy({team_id, title, body, private}); -octokit.teams.deleteDiscussionCommentInOrg({org, team_slug, discussion_number, comment_number}); -octokit.teams.deleteDiscussionCommentLegacy({team_id, discussion_number, comment_number}); -octokit.teams.deleteDiscussionInOrg({org, team_slug, discussion_number}); -octokit.teams.deleteDiscussionLegacy({team_id, discussion_number}); -octokit.teams.deleteInOrg({org, team_slug}); -octokit.teams.deleteLegacy({team_id}); -octokit.teams.getByName({org, team_slug}); -octokit.teams.getDiscussionCommentInOrg({org, team_slug, discussion_number, comment_number}); -octokit.teams.getDiscussionCommentLegacy({team_id, discussion_number, comment_number}); -octokit.teams.getDiscussionInOrg({org, team_slug, discussion_number}); -octokit.teams.getDiscussionLegacy({team_id, discussion_number}); -octokit.teams.getLegacy({team_id}); -octokit.teams.getMemberLegacy({team_id, username}); -octokit.teams.getMembershipForUserInOrg({org, team_slug, username}); -octokit.teams.getMembershipForUserLegacy({team_id, username}); -octokit.teams.list({org, per_page, page}); -octokit.teams.listChildInOrg({org, team_slug, per_page, page}); -octokit.teams.listChildLegacy({team_id, per_page, page}); -octokit.teams.listDiscussionCommentsInOrg({org, team_slug, discussion_number, direction, per_page, page}); -octokit.teams.listDiscussionCommentsLegacy({team_id, discussion_number, direction, per_page, page}); -octokit.teams.listDiscussionsInOrg({org, team_slug, direction, per_page, page, pinned}); -octokit.teams.listDiscussionsLegacy({team_id, direction, per_page, page}); -octokit.teams.listForAuthenticatedUser({per_page, page}); -octokit.teams.listMembersInOrg({org, team_slug, role, per_page, page}); -octokit.teams.listMembersLegacy({team_id, role, per_page, page}); -octokit.teams.listProjectsInOrg({org, team_slug, per_page, page}); -octokit.teams.listProjectsLegacy({team_id, per_page, page}); -octokit.teams.listReposInOrg({org, team_slug, per_page, page}); -octokit.teams.listReposLegacy({team_id, per_page, page}); -octokit.teams.removeMemberLegacy({team_id, username}); -octokit.teams.removeMembershipForUserInOrg({org, team_slug, username}); -octokit.teams.removeMembershipForUserLegacy({team_id, username}); -octokit.teams.removeProjectInOrg({org, team_slug, project_id}); -octokit.teams.removeProjectLegacy({team_id, project_id}); -octokit.teams.removeRepoInOrg({org, team_slug, owner, repo}); -octokit.teams.removeRepoLegacy({team_id, owner, repo}); -octokit.teams.updateDiscussionCommentInOrg({org, team_slug, discussion_number, comment_number, body}); -octokit.teams.updateDiscussionCommentLegacy({team_id, discussion_number, comment_number, body}); -octokit.teams.updateDiscussionInOrg({org, team_slug, discussion_number, title, body}); -octokit.teams.updateDiscussionLegacy({team_id, discussion_number, title, body}); -octokit.teams.updateInOrg({org, team_slug, name, description, privacy, permission, parent_team_id}); -octokit.teams.updateLegacy({team_id, name, description, privacy, permission, parent_team_id}); -octokit.users.addEmailForAuthenticated({emails}); -octokit.users.addEmailForAuthenticatedUser({emails}); -octokit.users.checkFollowingForUser({username, target_user}); -octokit.users.checkPersonIsFollowedByAuthenticated({username}); -octokit.users.createGpgKeyForAuthenticated({armored_public_key}); -octokit.users.createGpgKeyForAuthenticatedUser({armored_public_key}); -octokit.users.createPublicSshKeyForAuthenticated({title, key}); -octokit.users.createPublicSshKeyForAuthenticatedUser({title, key}); -octokit.users.deleteEmailForAuthenticated({emails}); -octokit.users.deleteEmailForAuthenticatedUser({emails}); -octokit.users.deleteGpgKeyForAuthenticated({gpg_key_id}); -octokit.users.deleteGpgKeyForAuthenticatedUser({gpg_key_id}); -octokit.users.deletePublicSshKeyForAuthenticated({key_id}); -octokit.users.deletePublicSshKeyForAuthenticatedUser({key_id}); -octokit.users.follow({username}); -octokit.users.getAuthenticated(); -octokit.users.getByUsername({username}); -octokit.users.getContextForUser({username, subject_type, subject_id}); -octokit.users.getGpgKeyForAuthenticated({gpg_key_id}); -octokit.users.getGpgKeyForAuthenticatedUser({gpg_key_id}); -octokit.users.getPublicSshKeyForAuthenticated({key_id}); -octokit.users.getPublicSshKeyForAuthenticatedUser({key_id}); -octokit.users.list({since, per_page}); -octokit.users.listEmailsForAuthenticated({per_page, page}); -octokit.users.listEmailsForAuthenticatedUser({per_page, page}); -octokit.users.listFollowedByAuthenticated({per_page, page}); -octokit.users.listFollowedByAuthenticatedUser({per_page, page}); -octokit.users.listFollowersForAuthenticatedUser({per_page, page}); -octokit.users.listFollowersForUser({username, per_page, page}); -octokit.users.listFollowingForUser({username, per_page, page}); -octokit.users.listGpgKeysForAuthenticated({per_page, page}); -octokit.users.listGpgKeysForAuthenticatedUser({per_page, page}); -octokit.users.listGpgKeysForUser({username, per_page, page}); -octokit.users.listPublicEmailsForAuthenticated({per_page, page}); -octokit.users.listPublicEmailsForAuthenticatedUser({per_page, page}); -octokit.users.listPublicKeysForUser({username, per_page, page}); -octokit.users.listPublicSshKeysForAuthenticated({per_page, page}); -octokit.users.listPublicSshKeysForAuthenticatedUser({per_page, page}); -octokit.users.unfollow({username}); -octokit.users.updateAuthenticated({name, email, blog, twitter_username, company, location, hireable, bio}); -``` diff --git a/docs/ghe-34.md b/docs/ghe-34.md index dc737be3..c030b2c1 100644 --- a/docs/ghe-34.md +++ b/docs/ghe-34.md @@ -265,7 +265,7 @@ octokit.actions.getSelfHostedRunnerForOrg({org, runner_id}); octokit.actions.getSelfHostedRunnerForRepo({owner, repo, runner_id}); octokit.actions.getWorkflow({owner, repo, workflow_id}); octokit.actions.getWorkflowRun({owner, repo, run_id, exclude_pull_requests}); -octokit.actions.listArtifactsForRepo({owner, repo, per_page, page}); +octokit.actions.listArtifactsForRepo({owner, repo, per_page, page, name}); octokit.actions.listEnvironmentSecrets({repository_id, environment_name, per_page, page}); octokit.actions.listJobsForWorkflowRun({owner, repo, run_id, filter, per_page, page}); octokit.actions.listLabelsForSelfHostedRunnerForOrg({org, runner_id}); @@ -330,10 +330,7 @@ octokit.activity.starRepoForAuthenticatedUser({owner, repo}); octokit.activity.unstarRepoForAuthenticatedUser({owner, repo}); octokit.apps.addRepoToInstallation({installation_id, repository_id}); octokit.apps.addRepoToInstallationForAuthenticatedUser({installation_id, repository_id}); -octokit.apps.checkAuthorization({client_id, access_token}); octokit.apps.checkToken({client_id, access_token}); -octokit.apps.createContentAttachment({content_reference_id, title, body}); -octokit.apps.createContentAttachmentForRepo({owner, repo, content_reference_id, title, body}); octokit.apps.createFromManifest({code}); octokit.apps.createInstallationAccessToken({installation_id, repositories, repository_ids, permissions}); octokit.apps.deleteAuthorization({client_id, access_token}); @@ -351,14 +348,11 @@ octokit.apps.listInstallationReposForAuthenticatedUser({installation_id, per_pag octokit.apps.listInstallations({per_page, page, since, outdated}); octokit.apps.listInstallationsForAuthenticatedUser({per_page, page}); octokit.apps.listReposAccessibleToInstallation({per_page, page}); -octokit.apps.listWebhookDeliveries({per_page, cursor}); +octokit.apps.listWebhookDeliveries({per_page, cursor, redelivery}); octokit.apps.redeliverWebhookDelivery({delivery_id}); octokit.apps.removeRepoFromInstallation({installation_id, repository_id}); octokit.apps.removeRepoFromInstallationForAuthenticatedUser({installation_id, repository_id}); -octokit.apps.resetAuthorization({client_id, access_token}); octokit.apps.resetToken({client_id, access_token}); -octokit.apps.revokeAuthorizationForApplication({client_id, access_token}); -octokit.apps.revokeGrantForApplication({client_id, access_token}); octokit.apps.revokeInstallationAccessToken(); octokit.apps.scopeToken({client_id, access_token, target, target_id, repositories, repository_ids, permissions}); octokit.apps.suspendInstallation({installation_id}); @@ -390,7 +384,6 @@ octokit.codeScanning.updateAlert({owner, repo, alert_number, state, dismissed_re octokit.codeScanning.uploadSarif({owner, repo, commit_sha, ref, sarif, checkout_uri, started_at, tool_name}); octokit.codesOfConduct.getAllCodesOfConduct(); octokit.codesOfConduct.getConductCode({key}); -octokit.codesOfConduct.getForRepo({owner, repo}); octokit.dependabot.addSelectedRepoToOrgSecret({org, secret_name, repository_id}); octokit.dependabot.createOrUpdateOrgSecret({org, secret_name, encrypted_value, key_id, visibility, selected_repository_ids}); octokit.dependabot.createOrUpdateRepoSecret({owner, repo, secret_name, encrypted_value, key_id}); @@ -444,6 +437,7 @@ octokit.gitignore.getTemplate({name}); octokit.issues.addAssignees({owner, repo, issue_number, assignees}); octokit.issues.addLabels({owner, repo, issue_number, labels}); octokit.issues.checkUserCanBeAssigned({owner, repo, assignee}); +octokit.issues.checkUserCanBeAssignedToIssue({owner, repo, issue_number, assignee}); octokit.issues.create({owner, repo, title, body, assignee, milestone, labels, assignees}); octokit.issues.createComment({owner, repo, issue_number, body}); octokit.issues.createLabel({owner, repo, name, color, description}); @@ -517,7 +511,7 @@ octokit.orgs.listMembers({org, filter, role, per_page, page}); octokit.orgs.listMembershipsForAuthenticatedUser({state, per_page, page}); octokit.orgs.listOutsideCollaborators({org, filter, per_page, page}); octokit.orgs.listPublicMembers({org, per_page, page}); -octokit.orgs.listWebhookDeliveries({org, hook_id, per_page, cursor}); +octokit.orgs.listWebhookDeliveries({org, hook_id, per_page, cursor, redelivery}); octokit.orgs.listWebhooks({org, per_page, page}); octokit.orgs.pingWebhook({org, hook_id}); octokit.orgs.redeliverWebhookDelivery({org, hook_id, delivery_id}); @@ -629,9 +623,9 @@ octokit.repos.createDeployment({owner, repo, ref, task, auto_merge, required_con octokit.repos.createDeploymentBranchPolicy({owner, repo, environment_name, name}); octokit.repos.createDeploymentStatus({owner, repo, deployment_id, state, target_url, log_url, description, environment, environment_url, auto_inactive}); octokit.repos.createDispatchEvent({owner, repo, event_type, client_payload}); -octokit.repos.createForAuthenticatedUser({name, description, homepage, private, has_issues, has_projects, has_wiki, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, has_downloads, is_template}); +octokit.repos.createForAuthenticatedUser({name, description, homepage, private, has_issues, has_projects, has_wiki, has_discussions, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, has_downloads, is_template}); octokit.repos.createFork({owner, repo, organization}); -octokit.repos.createInOrg({org, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, is_template, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message}); +octokit.repos.createInOrg({org, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, has_downloads, is_template, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message}); octokit.repos.createOrUpdateEnvironment({owner, repo, environment_name, wait_timer, reviewers, deployment_branch_policy}); octokit.repos.createOrUpdateFileContents({owner, repo, path, message, content, sha, branch, committer, author}); octokit.repos.createPagesSite({owner, repo, build_type, source}); @@ -709,7 +703,7 @@ octokit.repos.listAutolinks({owner, repo, page}); octokit.repos.listBranches({owner, repo, protected, per_page, page}); octokit.repos.listBranchesForHeadCommit({owner, repo, commit_sha}); octokit.repos.listCacheInfo({owner, repo, per_page, page}); -octokit.repos.listCollaborators({owner, repo, affiliation, permission, per_page, page}); +octokit.repos.listCollaborators({owner, repo, affiliation, per_page, page}); octokit.repos.listCommentsForCommit({owner, repo, commit_sha, per_page, page}); octokit.repos.listCommitCommentsForRepo({owner, repo, per_page, page}); octokit.repos.listCommitStatusesForRef({owner, repo, ref, per_page, page}); @@ -733,7 +727,7 @@ octokit.repos.listReleaseAssets({owner, repo, release_id, per_page, page}); octokit.repos.listReleases({owner, repo, per_page, page}); octokit.repos.listTags({owner, repo, per_page, page}); octokit.repos.listTeams({owner, repo, per_page, page}); -octokit.repos.listWebhookDeliveries({owner, repo, hook_id, per_page, cursor}); +octokit.repos.listWebhookDeliveries({owner, repo, hook_id, per_page, cursor, redelivery}); octokit.repos.listWebhooks({owner, repo, per_page, page}); octokit.repos.merge({owner, repo, base, head, commit_message}); octokit.repos.mergeUpstream({owner, repo, branch}); @@ -755,11 +749,11 @@ octokit.repos.setTeamAccessRestrictions({owner, repo, branch, teams}); octokit.repos.setUserAccessRestrictions({owner, repo, branch, users}); octokit.repos.testPushWebhook({owner, repo, hook_id}); octokit.repos.transfer({owner, repo, new_owner, team_ids}); -octokit.repos.update({owner, repo, name, description, homepage, private, visibility, security_and_analysis, has_issues, has_projects, has_wiki, is_template, default_branch, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, allow_update_branch, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, archived, allow_forking}); +octokit.repos.update({owner, repo, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, is_template, default_branch, allow_squash_merge, allow_merge_commit, allow_rebase_merge, delete_branch_on_merge, allow_update_branch, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, archived, allow_forking}); octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions, block_creations, required_conversation_resolution}); octokit.repos.updateCommitComment({owner, repo, comment_id, body}); octokit.repos.updateDeploymentBranchPolicy({owner, repo, environment_name, branch_policy_id, name}); -octokit.repos.updateInformationAboutPagesSite({owner, repo, cname, https_enforced, public, build_type, source}); +octokit.repos.updateInformationAboutPagesSite({owner, repo, cname, https_enforced, build_type, source}); octokit.repos.updateInvitation({owner, repo, invitation_id, permissions}); octokit.repos.updatePullRequestReviewProtection({owner, repo, branch, dismissal_restrictions, dismiss_stale_reviews, require_code_owner_reviews, required_approving_review_count, bypass_pull_request_allowances}); octokit.repos.updateRelease({owner, repo, release_id, tag_name, target_commitish, name, body, draft, prerelease}); diff --git a/docs/ghe-35.md b/docs/ghe-35.md index c1f118ed..bf4578c3 100644 --- a/docs/ghe-35.md +++ b/docs/ghe-35.md @@ -275,7 +275,7 @@ octokit.actions.getWorkflow({owner, repo, workflow_id}); octokit.actions.getWorkflowAccessToRepository({owner, repo}); octokit.actions.getWorkflowRun({owner, repo, run_id, exclude_pull_requests}); octokit.actions.getWorkflowRunAttempt({owner, repo, run_id, attempt_number, exclude_pull_requests}); -octokit.actions.listArtifactsForRepo({owner, repo, per_page, page}); +octokit.actions.listArtifactsForRepo({owner, repo, per_page, page, name}); octokit.actions.listEnvironmentSecrets({repository_id, environment_name, per_page, page}); octokit.actions.listJobsForWorkflowRun({owner, repo, run_id, filter, per_page, page}); octokit.actions.listJobsForWorkflowRunAttempt({owner, repo, run_id, attempt_number, per_page, page}); @@ -347,10 +347,7 @@ octokit.activity.starRepoForAuthenticatedUser({owner, repo}); octokit.activity.unstarRepoForAuthenticatedUser({owner, repo}); octokit.apps.addRepoToInstallation({installation_id, repository_id}); octokit.apps.addRepoToInstallationForAuthenticatedUser({installation_id, repository_id}); -octokit.apps.checkAuthorization({client_id, access_token}); octokit.apps.checkToken({client_id, access_token}); -octokit.apps.createContentAttachment({content_reference_id, title, body}); -octokit.apps.createContentAttachmentForRepo({owner, repo, content_reference_id, title, body}); octokit.apps.createFromManifest({code}); octokit.apps.createInstallationAccessToken({installation_id, repositories, repository_ids, permissions}); octokit.apps.deleteAuthorization({client_id, access_token}); @@ -368,14 +365,11 @@ octokit.apps.listInstallationReposForAuthenticatedUser({installation_id, per_pag octokit.apps.listInstallations({per_page, page, since, outdated}); octokit.apps.listInstallationsForAuthenticatedUser({per_page, page}); octokit.apps.listReposAccessibleToInstallation({per_page, page}); -octokit.apps.listWebhookDeliveries({per_page, cursor}); +octokit.apps.listWebhookDeliveries({per_page, cursor, redelivery}); octokit.apps.redeliverWebhookDelivery({delivery_id}); octokit.apps.removeRepoFromInstallation({installation_id, repository_id}); octokit.apps.removeRepoFromInstallationForAuthenticatedUser({installation_id, repository_id}); -octokit.apps.resetAuthorization({client_id, access_token}); octokit.apps.resetToken({client_id, access_token}); -octokit.apps.revokeAuthorizationForApplication({client_id, access_token}); -octokit.apps.revokeGrantForApplication({client_id, access_token}); octokit.apps.revokeInstallationAccessToken(); octokit.apps.scopeToken({client_id, access_token, target, target_id, repositories, repository_ids, permissions}); octokit.apps.suspendInstallation({installation_id}); @@ -408,7 +402,6 @@ octokit.codeScanning.updateAlert({owner, repo, alert_number, state, dismissed_re octokit.codeScanning.uploadSarif({owner, repo, commit_sha, ref, sarif, checkout_uri, started_at, tool_name}); octokit.codesOfConduct.getAllCodesOfConduct(); octokit.codesOfConduct.getConductCode({key}); -octokit.codesOfConduct.getForRepo({owner, repo}); octokit.dependabot.addSelectedRepoToOrgSecret({org, secret_name, repository_id}); octokit.dependabot.createOrUpdateOrgSecret({org, secret_name, encrypted_value, key_id, visibility, selected_repository_ids}); octokit.dependabot.createOrUpdateRepoSecret({owner, repo, secret_name, encrypted_value, key_id}); @@ -462,6 +455,7 @@ octokit.gitignore.getTemplate({name}); octokit.issues.addAssignees({owner, repo, issue_number, assignees}); octokit.issues.addLabels({owner, repo, issue_number, labels}); octokit.issues.checkUserCanBeAssigned({owner, repo, assignee}); +octokit.issues.checkUserCanBeAssignedToIssue({owner, repo, issue_number, assignee}); octokit.issues.create({owner, repo, title, body, assignee, milestone, labels, assignees}); octokit.issues.createComment({owner, repo, issue_number, body}); octokit.issues.createLabel({owner, repo, name, color, description}); @@ -535,7 +529,7 @@ octokit.orgs.listMembers({org, filter, role, per_page, page}); octokit.orgs.listMembershipsForAuthenticatedUser({state, per_page, page}); octokit.orgs.listOutsideCollaborators({org, filter, per_page, page}); octokit.orgs.listPublicMembers({org, per_page, page}); -octokit.orgs.listWebhookDeliveries({org, hook_id, per_page, cursor}); +octokit.orgs.listWebhookDeliveries({org, hook_id, per_page, cursor, redelivery}); octokit.orgs.listWebhooks({org, per_page, page}); octokit.orgs.pingWebhook({org, hook_id}); octokit.orgs.redeliverWebhookDelivery({org, hook_id, delivery_id}); @@ -648,9 +642,9 @@ octokit.repos.createDeployment({owner, repo, ref, task, auto_merge, required_con octokit.repos.createDeploymentBranchPolicy({owner, repo, environment_name, name}); octokit.repos.createDeploymentStatus({owner, repo, deployment_id, state, target_url, log_url, description, environment, environment_url, auto_inactive}); octokit.repos.createDispatchEvent({owner, repo, event_type, client_payload}); -octokit.repos.createForAuthenticatedUser({name, description, homepage, private, has_issues, has_projects, has_wiki, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, has_downloads, is_template}); +octokit.repos.createForAuthenticatedUser({name, description, homepage, private, has_issues, has_projects, has_wiki, has_discussions, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, has_downloads, is_template}); octokit.repos.createFork({owner, repo, organization}); -octokit.repos.createInOrg({org, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, is_template, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message}); +octokit.repos.createInOrg({org, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, has_downloads, is_template, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message}); octokit.repos.createOrUpdateEnvironment({owner, repo, environment_name, wait_timer, reviewers, deployment_branch_policy}); octokit.repos.createOrUpdateFileContents({owner, repo, path, message, content, sha, branch, committer, author}); octokit.repos.createPagesSite({owner, repo, build_type, source}); @@ -730,7 +724,7 @@ octokit.repos.listAutolinks({owner, repo, page}); octokit.repos.listBranches({owner, repo, protected, per_page, page}); octokit.repos.listBranchesForHeadCommit({owner, repo, commit_sha}); octokit.repos.listCacheInfo({owner, repo, per_page, page}); -octokit.repos.listCollaborators({owner, repo, affiliation, permission, per_page, page}); +octokit.repos.listCollaborators({owner, repo, affiliation, per_page, page}); octokit.repos.listCommentsForCommit({owner, repo, commit_sha, per_page, page}); octokit.repos.listCommitCommentsForRepo({owner, repo, per_page, page}); octokit.repos.listCommitStatusesForRef({owner, repo, ref, per_page, page}); @@ -755,7 +749,7 @@ octokit.repos.listReleases({owner, repo, per_page, page}); octokit.repos.listTagProtection({owner, repo}); octokit.repos.listTags({owner, repo, per_page, page}); octokit.repos.listTeams({owner, repo, per_page, page}); -octokit.repos.listWebhookDeliveries({owner, repo, hook_id, per_page, cursor}); +octokit.repos.listWebhookDeliveries({owner, repo, hook_id, per_page, cursor, redelivery}); octokit.repos.listWebhooks({owner, repo, per_page, page}); octokit.repos.merge({owner, repo, base, head, commit_message}); octokit.repos.mergeUpstream({owner, repo, branch}); @@ -777,11 +771,11 @@ octokit.repos.setTeamAccessRestrictions({owner, repo, branch, teams}); octokit.repos.setUserAccessRestrictions({owner, repo, branch, users}); octokit.repos.testPushWebhook({owner, repo, hook_id}); octokit.repos.transfer({owner, repo, new_owner, team_ids}); -octokit.repos.update({owner, repo, name, description, homepage, private, visibility, security_and_analysis, has_issues, has_projects, has_wiki, is_template, default_branch, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, allow_update_branch, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, archived, allow_forking}); +octokit.repos.update({owner, repo, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, is_template, default_branch, allow_squash_merge, allow_merge_commit, allow_rebase_merge, delete_branch_on_merge, allow_update_branch, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, archived, allow_forking}); octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions, block_creations, required_conversation_resolution}); octokit.repos.updateCommitComment({owner, repo, comment_id, body}); octokit.repos.updateDeploymentBranchPolicy({owner, repo, environment_name, branch_policy_id, name}); -octokit.repos.updateInformationAboutPagesSite({owner, repo, cname, https_enforced, public, build_type, source}); +octokit.repos.updateInformationAboutPagesSite({owner, repo, cname, https_enforced, build_type, source}); octokit.repos.updateInvitation({owner, repo, invitation_id, permissions}); octokit.repos.updatePullRequestReviewProtection({owner, repo, branch, dismissal_restrictions, dismiss_stale_reviews, require_code_owner_reviews, required_approving_review_count, bypass_pull_request_allowances}); octokit.repos.updateRelease({owner, repo, release_id, tag_name, target_commitish, name, body, draft, prerelease}); diff --git a/docs/ghe-36.md b/docs/ghe-36.md index b7f02f64..3670bb4f 100644 --- a/docs/ghe-36.md +++ b/docs/ghe-36.md @@ -38,12 +38,9 @@ octokit.enterpriseAdmin.deletePreReceiveEnvironment({ }); octokit.enterpriseAdmin.deletePreReceiveHook({ pre_receive_hook_id }); octokit.enterpriseAdmin.deletePublicKey({ key_ids }); -octokit.enterpriseAdmin.deleteScimGroupFromEnterprise({ - enterprise, - scim_group_id, -}); +octokit.enterpriseAdmin.deleteScimGroupFromEnterprise({ scim_group_id }); octokit.enterpriseAdmin.deleteUser({ username }); -octokit.enterpriseAdmin.deleteUserFromEnterprise({ enterprise, scim_user_id }); +octokit.enterpriseAdmin.deleteUserFromEnterprise({ scim_user_id }); octokit.enterpriseAdmin.demoteSiteAdministrator({ username }); octokit.enterpriseAdmin.disableSelectedOrganizationGithubActionsEnterprise({ enterprise, @@ -84,12 +81,10 @@ octokit.enterpriseAdmin.getPreReceiveHookForRepo({ pre_receive_hook_id, }); octokit.enterpriseAdmin.getProvisioningInformationForEnterpriseGroup({ - enterprise, scim_group_id, excludedAttributes, }); octokit.enterpriseAdmin.getProvisioningInformationForEnterpriseUser({ - enterprise, scim_user_id, }); octokit.enterpriseAdmin.getPullRequestStats(); @@ -130,17 +125,16 @@ octokit.enterpriseAdmin.listPreReceiveHooksForRepo({ sort, }); octokit.enterpriseAdmin.listProvisionedGroupsEnterprise({ - enterprise, - startIndex, - count, filter, excludedAttributes, + startIndex, + count, }); octokit.enterpriseAdmin.listProvisionedIdentitiesEnterprise({ - enterprise, + filter, + excludedAttributes, startIndex, count, - filter, }); octokit.enterpriseAdmin.listPublicKeys({ per_page, @@ -154,19 +148,21 @@ octokit.enterpriseAdmin.listSelectedOrganizationsEnabledGithubActionsEnterprise( ); octokit.enterpriseAdmin.pingGlobalWebhook({ hook_id }); octokit.enterpriseAdmin.promoteUserToBeSiteAdministrator({ username }); -octokit.enterpriseAdmin.provisionAndInviteEnterpriseGroup({ - enterprise, +octokit.enterpriseAdmin.provisionEnterpriseGroup({ schemas, + externalId, displayName, members, }); -octokit.enterpriseAdmin.provisionAndInviteEnterpriseUser({ - enterprise, +octokit.enterpriseAdmin.provisionEnterpriseUser({ schemas, + externalId, + active, userName, name, + displayName, emails, - groups, + roles, }); octokit.enterpriseAdmin.removeAllCustomLabelsFromSelfHostedRunnerForEnterprise({ enterprise, @@ -205,20 +201,22 @@ octokit.enterpriseAdmin.setGithubActionsPermissionsEnterprise({ allowed_actions, }); octokit.enterpriseAdmin.setInformationForProvisionedEnterpriseGroup({ - enterprise, scim_group_id, schemas, + externalId, displayName, members, }); octokit.enterpriseAdmin.setInformationForProvisionedEnterpriseUser({ - enterprise, scim_user_id, schemas, + externalId, + active, userName, name, + displayName, emails, - groups, + roles, }); octokit.enterpriseAdmin.setSelectedOrganizationsEnabledGithubActionsEnterprise({ enterprise, @@ -234,16 +232,14 @@ octokit.enterpriseAdmin.syncLdapMappingForTeam({ team_id }); octokit.enterpriseAdmin.syncLdapMappingForUser({ username }); octokit.enterpriseAdmin.unsuspendUser({ username, reason }); octokit.enterpriseAdmin.updateAttributeForEnterpriseGroup({ - enterprise, scim_group_id, - schemas, Operations, + schemas, }); octokit.enterpriseAdmin.updateAttributeForEnterpriseUser({ - enterprise, scim_user_id, - schemas, Operations, + schemas, }); octokit.enterpriseAdmin.updateGlobalWebhook({ hook_id, @@ -346,7 +342,7 @@ octokit.actions.getWorkflow({owner, repo, workflow_id}); octokit.actions.getWorkflowAccessToRepository({owner, repo}); octokit.actions.getWorkflowRun({owner, repo, run_id, exclude_pull_requests}); octokit.actions.getWorkflowRunAttempt({owner, repo, run_id, attempt_number, exclude_pull_requests}); -octokit.actions.listArtifactsForRepo({owner, repo, per_page, page}); +octokit.actions.listArtifactsForRepo({owner, repo, per_page, page, name}); octokit.actions.listEnvironmentSecrets({repository_id, environment_name, per_page, page}); octokit.actions.listJobsForWorkflowRun({owner, repo, run_id, filter, per_page, page}); octokit.actions.listJobsForWorkflowRunAttempt({owner, repo, run_id, attempt_number, per_page, page}); @@ -420,10 +416,7 @@ octokit.activity.starRepoForAuthenticatedUser({owner, repo}); octokit.activity.unstarRepoForAuthenticatedUser({owner, repo}); octokit.apps.addRepoToInstallation({installation_id, repository_id}); octokit.apps.addRepoToInstallationForAuthenticatedUser({installation_id, repository_id}); -octokit.apps.checkAuthorization({client_id, access_token}); octokit.apps.checkToken({client_id, access_token}); -octokit.apps.createContentAttachment({content_reference_id, title, body}); -octokit.apps.createContentAttachmentForRepo({owner, repo, content_reference_id, title, body}); octokit.apps.createFromManifest({code}); octokit.apps.createInstallationAccessToken({installation_id, repositories, repository_ids, permissions}); octokit.apps.deleteAuthorization({client_id, access_token}); @@ -441,14 +434,11 @@ octokit.apps.listInstallationReposForAuthenticatedUser({installation_id, per_pag octokit.apps.listInstallations({per_page, page, since, outdated}); octokit.apps.listInstallationsForAuthenticatedUser({per_page, page}); octokit.apps.listReposAccessibleToInstallation({per_page, page}); -octokit.apps.listWebhookDeliveries({per_page, cursor}); +octokit.apps.listWebhookDeliveries({per_page, cursor, redelivery}); octokit.apps.redeliverWebhookDelivery({delivery_id}); octokit.apps.removeRepoFromInstallation({installation_id, repository_id}); octokit.apps.removeRepoFromInstallationForAuthenticatedUser({installation_id, repository_id}); -octokit.apps.resetAuthorization({client_id, access_token}); octokit.apps.resetToken({client_id, access_token}); -octokit.apps.revokeAuthorizationForApplication({client_id, access_token}); -octokit.apps.revokeGrantForApplication({client_id, access_token}); octokit.apps.revokeInstallationAccessToken(); octokit.apps.scopeToken({client_id, access_token, target, target_id, repositories, repository_ids, permissions}); octokit.apps.suspendInstallation({installation_id}); @@ -481,7 +471,6 @@ octokit.codeScanning.updateAlert({owner, repo, alert_number, state, dismissed_re octokit.codeScanning.uploadSarif({owner, repo, commit_sha, ref, sarif, checkout_uri, started_at, tool_name}); octokit.codesOfConduct.getAllCodesOfConduct(); octokit.codesOfConduct.getConductCode({key}); -octokit.codesOfConduct.getForRepo({owner, repo}); octokit.dependabot.addSelectedRepoToOrgSecret({org, secret_name, repository_id}); octokit.dependabot.createOrUpdateOrgSecret({org, secret_name, encrypted_value, key_id, visibility, selected_repository_ids}); octokit.dependabot.createOrUpdateRepoSecret({owner, repo, secret_name, encrypted_value, key_id}); @@ -536,6 +525,7 @@ octokit.gitignore.getTemplate({name}); octokit.issues.addAssignees({owner, repo, issue_number, assignees}); octokit.issues.addLabels({owner, repo, issue_number, labels}); octokit.issues.checkUserCanBeAssigned({owner, repo, assignee}); +octokit.issues.checkUserCanBeAssignedToIssue({owner, repo, issue_number, assignee}); octokit.issues.create({owner, repo, title, body, assignee, milestone, labels, assignees}); octokit.issues.createComment({owner, repo, issue_number, body}); octokit.issues.createLabel({owner, repo, name, color, description}); @@ -609,7 +599,7 @@ octokit.orgs.listMembers({org, filter, role, per_page, page}); octokit.orgs.listMembershipsForAuthenticatedUser({state, per_page, page}); octokit.orgs.listOutsideCollaborators({org, filter, per_page, page}); octokit.orgs.listPublicMembers({org, per_page, page}); -octokit.orgs.listWebhookDeliveries({org, hook_id, per_page, cursor}); +octokit.orgs.listWebhookDeliveries({org, hook_id, per_page, cursor, redelivery}); octokit.orgs.listWebhooks({org, per_page, page}); octokit.orgs.pingWebhook({org, hook_id}); octokit.orgs.redeliverWebhookDelivery({org, hook_id, delivery_id}); @@ -722,9 +712,9 @@ octokit.repos.createDeployment({owner, repo, ref, task, auto_merge, required_con octokit.repos.createDeploymentBranchPolicy({owner, repo, environment_name, name}); octokit.repos.createDeploymentStatus({owner, repo, deployment_id, state, target_url, log_url, description, environment, environment_url, auto_inactive}); octokit.repos.createDispatchEvent({owner, repo, event_type, client_payload}); -octokit.repos.createForAuthenticatedUser({name, description, homepage, private, has_issues, has_projects, has_wiki, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, has_downloads, is_template}); +octokit.repos.createForAuthenticatedUser({name, description, homepage, private, has_issues, has_projects, has_wiki, has_discussions, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, has_downloads, is_template}); octokit.repos.createFork({owner, repo, organization}); -octokit.repos.createInOrg({org, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, is_template, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message}); +octokit.repos.createInOrg({org, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, has_downloads, is_template, team_id, auto_init, gitignore_template, license_template, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message}); octokit.repos.createOrUpdateEnvironment({owner, repo, environment_name, wait_timer, reviewers, deployment_branch_policy}); octokit.repos.createOrUpdateFileContents({owner, repo, path, message, content, sha, branch, committer, author}); octokit.repos.createPagesSite({owner, repo, build_type, source}); @@ -804,7 +794,7 @@ octokit.repos.listAutolinks({owner, repo, page}); octokit.repos.listBranches({owner, repo, protected, per_page, page}); octokit.repos.listBranchesForHeadCommit({owner, repo, commit_sha}); octokit.repos.listCacheInfo({owner, repo, per_page, page}); -octokit.repos.listCollaborators({owner, repo, affiliation, permission, per_page, page}); +octokit.repos.listCollaborators({owner, repo, affiliation, per_page, page}); octokit.repos.listCommentsForCommit({owner, repo, commit_sha, per_page, page}); octokit.repos.listCommitCommentsForRepo({owner, repo, per_page, page}); octokit.repos.listCommitStatusesForRef({owner, repo, ref, per_page, page}); @@ -829,7 +819,7 @@ octokit.repos.listReleases({owner, repo, per_page, page}); octokit.repos.listTagProtection({owner, repo}); octokit.repos.listTags({owner, repo, per_page, page}); octokit.repos.listTeams({owner, repo, per_page, page}); -octokit.repos.listWebhookDeliveries({owner, repo, hook_id, per_page, cursor}); +octokit.repos.listWebhookDeliveries({owner, repo, hook_id, per_page, cursor, redelivery}); octokit.repos.listWebhooks({owner, repo, per_page, page}); octokit.repos.merge({owner, repo, base, head, commit_message}); octokit.repos.mergeUpstream({owner, repo, branch}); @@ -851,11 +841,11 @@ octokit.repos.setTeamAccessRestrictions({owner, repo, branch, teams}); octokit.repos.setUserAccessRestrictions({owner, repo, branch, users}); octokit.repos.testPushWebhook({owner, repo, hook_id}); octokit.repos.transfer({owner, repo, new_owner, team_ids}); -octokit.repos.update({owner, repo, name, description, homepage, private, visibility, security_and_analysis, has_issues, has_projects, has_wiki, is_template, default_branch, allow_squash_merge, allow_merge_commit, allow_rebase_merge, allow_auto_merge, delete_branch_on_merge, allow_update_branch, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, archived, allow_forking, web_commit_signoff_required}); +octokit.repos.update({owner, repo, name, description, homepage, private, visibility, has_issues, has_projects, has_wiki, is_template, default_branch, allow_squash_merge, allow_merge_commit, allow_rebase_merge, delete_branch_on_merge, allow_update_branch, use_squash_pr_title_as_default, squash_merge_commit_title, squash_merge_commit_message, merge_commit_title, merge_commit_message, archived, allow_forking, web_commit_signoff_required}); octokit.repos.updateBranchProtection({owner, repo, branch, required_status_checks, enforce_admins, required_pull_request_reviews, restrictions, required_linear_history, allow_force_pushes, allow_deletions, block_creations, required_conversation_resolution}); octokit.repos.updateCommitComment({owner, repo, comment_id, body}); octokit.repos.updateDeploymentBranchPolicy({owner, repo, environment_name, branch_policy_id, name}); -octokit.repos.updateInformationAboutPagesSite({owner, repo, cname, https_enforced, public, build_type, source}); +octokit.repos.updateInformationAboutPagesSite({owner, repo, cname, https_enforced, build_type, source}); octokit.repos.updateInvitation({owner, repo, invitation_id, permissions}); octokit.repos.updatePullRequestReviewProtection({owner, repo, branch, dismissal_restrictions, dismiss_stale_reviews, require_code_owner_reviews, required_approving_review_count, bypass_pull_request_allowances}); octokit.repos.updateRelease({owner, repo, release_id, tag_name, target_commitish, name, body, draft, prerelease}); diff --git a/package-lock.json b/package-lock.json index fa654f96..64d0d08b 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "@octokit/types": "^8.1.1" + "@octokit/types": "^9.0.0" }, "devDependencies": { "@octokit/core": "^4.0.0", @@ -2615,6 +2615,15 @@ "node": ">= 14" } }, + "node_modules/@octokit/auth-token/node_modules/@octokit/types": { + "version": "8.2.1", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-8.2.1.tgz", + "integrity": "sha512-8oWMUji8be66q2B9PmEIUyQm00VPDPun07umUWSaCwxmeaquFBro4Hcc3ruVoDo3zkQyZBlRvhIMEYS3pBhanw==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^14.0.0" + } + }, "node_modules/@octokit/core": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/@octokit/core/-/core-4.1.0.tgz", @@ -2633,6 +2642,15 @@ "node": ">= 14" } }, + "node_modules/@octokit/core/node_modules/@octokit/types": { + "version": "8.2.1", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-8.2.1.tgz", + "integrity": "sha512-8oWMUji8be66q2B9PmEIUyQm00VPDPun07umUWSaCwxmeaquFBro4Hcc3ruVoDo3zkQyZBlRvhIMEYS3pBhanw==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^14.0.0" + } + }, "node_modules/@octokit/endpoint": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-7.0.3.tgz", @@ -2647,6 +2665,15 @@ "node": ">= 14" } }, + "node_modules/@octokit/endpoint/node_modules/@octokit/types": { + "version": "8.2.1", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-8.2.1.tgz", + "integrity": "sha512-8oWMUji8be66q2B9PmEIUyQm00VPDPun07umUWSaCwxmeaquFBro4Hcc3ruVoDo3zkQyZBlRvhIMEYS3pBhanw==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^14.0.0" + } + }, "node_modules/@octokit/graphql": { "version": "5.0.4", "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-5.0.4.tgz", @@ -2661,10 +2688,20 @@ "node": ">= 14" } }, + "node_modules/@octokit/graphql/node_modules/@octokit/types": { + "version": "8.2.1", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-8.2.1.tgz", + "integrity": "sha512-8oWMUji8be66q2B9PmEIUyQm00VPDPun07umUWSaCwxmeaquFBro4Hcc3ruVoDo3zkQyZBlRvhIMEYS3pBhanw==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^14.0.0" + } + }, "node_modules/@octokit/openapi-types": { "version": "14.0.0", "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-14.0.0.tgz", - "integrity": "sha512-HNWisMYlR8VCnNurDU6os2ikx0s0VyEjDYHNS/h4cgb8DeOxQ0n72HyinUtdDVxJhFy3FWLGl0DJhfEWk3P5Iw==" + "integrity": "sha512-HNWisMYlR8VCnNurDU6os2ikx0s0VyEjDYHNS/h4cgb8DeOxQ0n72HyinUtdDVxJhFy3FWLGl0DJhfEWk3P5Iw==", + "dev": true }, "node_modules/@octokit/request": { "version": "6.2.2", @@ -2697,14 +2734,37 @@ "node": ">= 14" } }, - "node_modules/@octokit/types": { - "version": "8.1.1", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-8.1.1.tgz", - "integrity": "sha512-7tjk+6DyhYAmei8FOEwPfGKc0VE1x56CKPJ+eE44zhDbOyMT+9yan8apfQFxo8oEFsy+0O7PiBtH8w0Yo0Y9Kw==", + "node_modules/@octokit/request-error/node_modules/@octokit/types": { + "version": "8.2.1", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-8.2.1.tgz", + "integrity": "sha512-8oWMUji8be66q2B9PmEIUyQm00VPDPun07umUWSaCwxmeaquFBro4Hcc3ruVoDo3zkQyZBlRvhIMEYS3pBhanw==", + "dev": true, "dependencies": { "@octokit/openapi-types": "^14.0.0" } }, + "node_modules/@octokit/request/node_modules/@octokit/types": { + "version": "8.2.1", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-8.2.1.tgz", + "integrity": "sha512-8oWMUji8be66q2B9PmEIUyQm00VPDPun07umUWSaCwxmeaquFBro4Hcc3ruVoDo3zkQyZBlRvhIMEYS3pBhanw==", + "dev": true, + "dependencies": { + "@octokit/openapi-types": "^14.0.0" + } + }, + "node_modules/@octokit/types": { + "version": "9.0.0", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-9.0.0.tgz", + "integrity": "sha512-LUewfj94xCMH2rbD5YJ+6AQ4AVjFYTgpp6rboWM5T7N3IsIF65SBEOVcYMGAEzO/kKNiNaW4LoWtoThOhH06gw==", + "dependencies": { + "@octokit/openapi-types": "^16.0.0" + } + }, + "node_modules/@octokit/types/node_modules/@octokit/openapi-types": { + "version": "16.0.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-16.0.0.tgz", + "integrity": "sha512-JbFWOqTJVLHZSUUoF4FzAZKYtqdxWu9Z5m2QQnOyEa04fOFljvyh7D3GYKbfuaSWisqehImiVIMG4eyJeP5VEA==" + }, "node_modules/@pika/babel-plugin-esm-import-rewrite": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/@pika/babel-plugin-esm-import-rewrite/-/babel-plugin-esm-import-rewrite-0.6.1.tgz", diff --git a/package.json b/package.json index f4d5586b..b9c669e3 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,7 @@ "author": "Gregor Martynus (https://github.com/gr2m)", "license": "MIT", "dependencies": { - "@octokit/types": "^8.1.1" + "@octokit/types": "^9.0.0" }, "peerDependencies": { "@octokit/core": ">=3" diff --git a/scripts/update-endpoints/generated/ghe30-endpoints.json b/scripts/update-endpoints/generated/ghe30-endpoints.json deleted file mode 100644 index e8839af0..00000000 --- a/scripts/update-endpoints/generated/ghe30-endpoints.json +++ /dev/null @@ -1,47937 +0,0 @@ -[ - { - "name": "Add selected repository to an organization secret", - "scope": "actions", - "id": "addSelectedRepoToOrgSecret", - "method": "PUT", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#add-selected-repository-to-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "secret_name parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "No Content when repository was added to the selected list", - "examples": null - }, - { - "code": 409, - "description": "Conflict when visibility type is not set to selected", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Cancel a workflow run", - "scope": "actions", - "id": "cancelWorkflowRun", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", - "isDeprecated": false, - "deprecationDate": null, - "description": "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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#cancel-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The id of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 202, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Create or update an organization secret", - "scope": "actions", - "id": "createOrUpdateOrgSecret", - "method": "PUT", - "url": "/orgs/{org}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#create-or-update-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "secret_name parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "encrypted_value", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-public-key) endpoint.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "ID of the key you used to encrypt the secret.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Configures the access that repositories have to the organization secret. Can be one of: \n\\- `all` - All repositories in an organization can access the secret. \n\\- `private` - Private repositories in an organization can access the secret. \n\\- `selected` - Only specific repositories can access the secret.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["all", "private", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response when creating a secret", - "examples": null - }, - { - "code": 204, - "description": "Response when updating a secret", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create or update a repository secret", - "scope": "actions", - "id": "createOrUpdateRepoSecret", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#create-or-update-a-repository-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "secret_name parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "encrypted_value", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-public-key) endpoint.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "ID of the key you used to encrypt the secret.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response when creating a secret", - "examples": null - }, - { - "code": 204, - "description": "Response when updating a secret", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a registration token for an organization", - "scope": "actions", - "id": "createRegistrationTokenForOrg", - "method": "POST", - "url": "/orgs/{org}/actions/runners/registration-token", - "isDeprecated": false, - "deprecationDate": 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.\n\n#### Example 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```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#create-a-registration-token-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"LLBF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-22T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a registration token for a repository", - "scope": "actions", - "id": "createRegistrationTokenForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runners/registration-token", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate\nusing an access token with the `repo` scope to use this endpoint.\n\n#### Example 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/octo-repo-artifacts --token TOKEN\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#create-a-registration-token-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"LLBF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-22T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a remove token for an organization", - "scope": "actions", - "id": "createRemoveTokenForOrg", - "method": "POST", - "url": "/orgs/{org}/actions/runners/remove-token", - "isDeprecated": false, - "deprecationDate": 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.\n\n#### Example 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```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#create-a-remove-token-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"AABF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-29T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a remove token for a repository", - "scope": "actions", - "id": "createRemoveTokenForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runners/remove-token", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\n\n#### Example using remove token\n \nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.\n\n```\n./config.sh remove --token TOKEN\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#create-a-remove-token-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"AABF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-29T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a workflow dispatch event", - "scope": "actions", - "id": "createWorkflowDispatch", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#create-a-workflow-dispatch-event", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The git reference for the workflow. The reference can be a branch or tag name.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "inputs", - "description": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "inputs.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an artifact", - "scope": "actions", - "id": "deleteArtifact", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#delete-an-artifact", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "artifact_id", - "description": "artifact_id parameter", - "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 secret", - "scope": "actions", - "id": "deleteOrgSecret", - "method": "DELETE", - "url": "/orgs/{org}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": 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 `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#delete-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "secret_name parameter", - "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": "Delete a repository secret", - "scope": "actions", - "id": "deleteRepoSecret", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": 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 `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#delete-a-repository-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "secret_name parameter", - "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": "Delete a self-hosted runner from an organization", - "scope": "actions", - "id": "deleteSelfHostedRunnerFromOrg", - "method": "DELETE", - "url": "/orgs/{org}/actions/runners/{runner_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a self-hosted runner from a repository", - "scope": "actions", - "id": "deleteSelfHostedRunnerFromRepo", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "isDeprecated": false, - "deprecationDate": 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`\nscope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a workflow run", - "scope": "actions", - "id": "deleteWorkflowRun", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#delete-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The id of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete workflow run logs", - "scope": "actions", - "id": "deleteWorkflowRunLogs", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#delete-workflow-run-logs", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The id of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Disable a selected repository for GitHub Actions in an organization", - "scope": "actions", - "id": "disableSelectedRepositoryGithubActionsOrganization", - "method": "DELETE", - "url": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "", - "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": "Disable a workflow", - "scope": "actions", - "id": "disableWorkflow", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#disable-a-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Download an artifact", - "scope": "actions", - "id": "downloadArtifact", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", - "isDeprecated": false, - "deprecationDate": 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`. 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#download-an-artifact", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "artifact_id", - "description": "artifact_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "archive_format", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Download job logs for a workflow run", - "scope": "actions", - "id": "downloadJobLogsForWorkflowRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#download-job-logs-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "job_id", - "description": "job_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Download workflow run logs", - "scope": "actions", - "id": "downloadWorkflowRunLogs", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#download-workflow-run-logs", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The id of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Enable a selected repository for GitHub Actions in an organization", - "scope": "actions", - "id": "enableSelectedRepositoryGithubActionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "", - "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": "Enable a workflow", - "scope": "actions", - "id": "enableWorkflow", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#enable-a-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get allowed actions for an organization", - "scope": "actions", - "id": "getAllowedActionsOrganization", - "method": "GET", - "url": "/orgs/{org}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-allowed-actions-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get allowed actions for a repository", - "scope": "actions", - "id": "getAllowedActionsRepository", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-allowed-actions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an artifact", - "scope": "actions", - "id": "getArtifact", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-artifact", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "artifact_id", - "description": "artifact_id parameter", - "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\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-01-21T14:59:22Z\",\"updated_at\":\"2020-01-21T14:59:22Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get GitHub Actions permissions for an organization", - "scope": "actions", - "id": "getGithubActionsPermissionsOrganization", - "method": "GET", - "url": "/orgs/{org}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-github-actions-permissions-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"enabled_repositories\":\"all\",\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/organizations/42/actions/permissions/selected-actions\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get GitHub Actions permissions for a repository", - "scope": "actions", - "id": "getGithubActionsPermissionsRepository", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-github-actions-permissions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"enabled\":true,\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/repositories/42/actions/permissions/selected-actions\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a job for a workflow run", - "scope": "actions", - "id": "getJobForWorkflowRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-job-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "job_id", - "description": "job_id parameter", - "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\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an organization public key", - "scope": "actions", - "id": "getOrgPublicKey", - "method": "GET", - "url": "/orgs/{org}/actions/secrets/public-key", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-public-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an organization secret", - "scope": "actions", - "id": "getOrgSecret", - "method": "GET", - "url": "/orgs/{org}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "secret_name parameter", - "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\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository public key", - "scope": "actions", - "id": "getRepoPublicKey", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets/public-key", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-public-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository secret", - "scope": "actions", - "id": "getRepoSecret", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "secret_name parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a self-hosted runner for an organization", - "scope": "actions", - "id": "getSelfHostedRunnerForOrg", - "method": "GET", - "url": "/orgs/{org}/actions/runners/{runner_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-self-hosted-runner-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a self-hosted runner for a repository", - "scope": "actions", - "id": "getSelfHostedRunnerForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-self-hosted-runner-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a workflow", - "scope": "actions", - "id": "getWorkflow", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a workflow run", - "scope": "actions", - "id": "getWorkflowRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The id of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List artifacts for a repository", - "scope": "actions", - "id": "listArtifactsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-artifacts-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List jobs for a workflow run", - "scope": "actions", - "id": "listJobsForWorkflowRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#parameters).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-jobs-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The id of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filters jobs by their `completed_at` timestamp. Can be one of: \n\\* `latest`: Returns jobs from the most recent execution of the workflow run. \n\\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["latest", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organization secrets", - "scope": "actions", - "id": "listOrgSecrets", - "method": "GET", - "url": "/orgs/{org}/actions/secrets", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-organization-secrets", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":3,\"secrets\":[{\"name\":\"GIST_ID\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"DEPLOY_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository secrets", - "scope": "actions", - "id": "listRepoSecrets", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-repository-secrets", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository workflows", - "scope": "actions", - "id": "listRepoWorkflows", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-repository-workflows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"},{\"id\":269289,\"node_id\":\"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\"name\":\"Linter\",\"path\":\".github/workflows/linter.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List runner applications for an organization", - "scope": "actions", - "id": "listRunnerApplicationsForOrg", - "method": "GET", - "url": "/orgs/{org}/actions/runners/downloads", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-runner-applications-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List runner applications for a repository", - "scope": "actions", - "id": "listRunnerApplicationsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners/downloads", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-runner-applications-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List selected repositories for an organization secret", - "scope": "actions", - "id": "listSelectedReposForOrgSecret", - "method": "GET", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-selected-repositories-for-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "secret_name parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List selected repositories enabled for GitHub Actions in an organization", - "scope": "actions", - "id": "listSelectedRepositoriesEnabledGithubActionsOrganization", - "method": "GET", - "url": "/orgs/{org}/actions/permissions/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List self-hosted runners for an organization", - "scope": "actions", - "id": "listSelfHostedRunnersForOrg", - "method": "GET", - "url": "/orgs/{org}/actions/runners", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all self-hosted runners configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-self-hosted-runners-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List self-hosted runners for a repository", - "scope": "actions", - "id": "listSelfHostedRunnersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-self-hosted-runners-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List workflow run artifacts", - "scope": "actions", - "id": "listWorkflowRunArtifacts", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-workflow-run-artifacts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The id of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List workflow runs", - "scope": "actions", - "id": "listWorkflowRuns", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-workflow-runs", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actor", - "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "completed", - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "in_progress", - "queued", - "requested", - "waiting" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "created", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List workflow runs for a repository", - "scope": "actions", - "id": "listWorkflowRunsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#list-workflow-runs-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actor", - "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "completed", - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "in_progress", - "queued", - "requested", - "waiting" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "created", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Re-run a workflow", - "scope": "actions", - "id": "reRunWorkflow", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", - "isDeprecated": false, - "deprecationDate": null, - "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#re-run-a-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The id of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 201, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove selected repository from an organization secret", - "scope": "actions", - "id": "removeSelectedRepoFromOrgSecret", - "method": "DELETE", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#remove-selected-repository-from-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "secret_name parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response when repository was removed from the selected list", - "examples": null - }, - { - "code": 409, - "description": "Conflict when visibility type not set to selected", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Set allowed actions for an organization", - "scope": "actions", - "id": "setAllowedActionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#set-allowed-actions-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "github_owned_allowed", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "patterns_allowed", - "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "in": "BODY", - "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": "Set allowed actions for a repository", - "scope": "actions", - "id": "setAllowedActionsRepository", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#set-allowed-actions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "github_owned_allowed", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "patterns_allowed", - "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "in": "BODY", - "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": "Set GitHub Actions permissions for an organization", - "scope": "actions", - "id": "setGithubActionsPermissionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#set-github-actions-permissions-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enabled_repositories", - "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["all", "none", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allowed_actions", - "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "local_only", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Set GitHub Actions permissions for a repository", - "scope": "actions", - "id": "setGithubActionsPermissionsRepository", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#set-github-actions-permissions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enabled", - "description": "Whether GitHub Actions is enabled on the repository.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allowed_actions", - "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "local_only", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Set selected repositories for an organization secret", - "scope": "actions", - "id": "setSelectedReposForOrgSecret", - "method": "PUT", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.0/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#set-selected-repositories-for-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "secret_name parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "in": "BODY", - "type": "integer[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Set selected repositories enabled for GitHub Actions in an organization", - "scope": "actions", - "id": "setSelectedRepositoriesEnabledGithubActionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "description": "List of repository IDs to enable for GitHub Actions.", - "in": "BODY", - "type": "integer[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Check if a repository is starred by the authenticated user", - "scope": "activity", - "id": "checkRepoIsStarredByAuthenticatedUser", - "method": "GET", - "url": "/user/starred/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if this repository is starred by you", - "examples": null - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if this repository is not starred by you", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a repository subscription", - "scope": "activity", - "id": "deleteRepoSubscription", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.0/rest/reference/activity#set-a-repository-subscription).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#delete-a-repository-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a thread subscription", - "scope": "activity", - "id": "deleteThreadSubscription", - "method": "DELETE", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.0/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#delete-a-thread-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "thread_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get feeds", - "scope": "activity", - "id": "getFeeds", - "method": "GET", - "url": "/feeds", - "isDeprecated": false, - "deprecationDate": null, - "description": "GitHub Enterprise Server 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 Enterprise Server global public timeline\n* **User**: The public timeline for any user, using [URI template](https://docs.github.com/enterprise-server@3.0/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 Enterprise Server.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#get-feeds", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"timeline_url\":\"https://github.com/timeline\",\"user_url\":\"https://github.com/{user}\",\"current_user_public_url\":\"https://github.com/octocat\",\"current_user_url\":\"https://github.com/octocat.private?token=abc123\",\"current_user_actor_url\":\"https://github.com/octocat.private.actor?token=abc123\",\"current_user_organization_url\":\"\",\"current_user_organization_urls\":[\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"],\"_links\":{\"timeline\":{\"href\":\"https://github.com/timeline\",\"type\":\"application/atom+xml\"},\"user\":{\"href\":\"https://github.com/{user}\",\"type\":\"application/atom+xml\"},\"current_user_public\":{\"href\":\"https://github.com/octocat\",\"type\":\"application/atom+xml\"},\"current_user\":{\"href\":\"https://github.com/octocat.private?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_actor\":{\"href\":\"https://github.com/octocat.private.actor?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_organization\":{\"href\":\"\",\"type\":\"\"},\"current_user_organizations\":[{\"href\":\"https://github.com/organizations/github/octocat.private.atom?token=abc123\",\"type\":\"application/atom+xml\"}]}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository subscription", - "scope": "activity", - "id": "getRepoSubscription", - "method": "GET", - "url": "/repos/{owner}/{repo}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#get-a-repository-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if you subscribe to the repository", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if you don't subscribe to the repository", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a thread", - "scope": "activity", - "id": "getThread", - "method": "GET", - "url": "/notifications/threads/{thread_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#get-a-thread", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "thread_id parameter", - "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\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a thread subscription for the authenticated user", - "scope": "activity", - "id": "getThreadSubscriptionForAuthenticatedUser", - "method": "GET", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.0/rest/reference/activity#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "thread_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List events for the authenticated user", - "scope": "activity", - "id": "listEventsForAuthenticatedUser", - "method": "GET", - "url": "/users/{username}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-events-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "List notifications for the authenticated user", - "scope": "activity", - "id": "listNotificationsForAuthenticatedUser", - "method": "GET", - "url": "/notifications", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all notifications for the current user, sorted by most recently updated.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-notifications-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "all", - "description": "If `true`, show notifications marked as read.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "participating", - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List organization events for the authenticated user", - "scope": "activity", - "id": "listOrgEventsForAuthenticatedUser", - "method": "GET", - "url": "/users/{username}/events/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-organization-events-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "List public events", - "scope": "activity", - "id": "listPublicEvents", - "method": "GET", - "url": "/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-public-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List public events for a network of repositories", - "scope": "activity", - "id": "listPublicEventsForRepoNetwork", - "method": "GET", - "url": "/networks/{owner}/{repo}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-public-events-for-a-network-of-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List public events for a user", - "scope": "activity", - "id": "listPublicEventsForUser", - "method": "GET", - "url": "/users/{username}/events/public", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-public-events-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "List public organization events", - "scope": "activity", - "id": "listPublicOrgEvents", - "method": "GET", - "url": "/orgs/{org}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-public-organization-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "List events received by the authenticated user", - "scope": "activity", - "id": "listReceivedEventsForUser", - "method": "GET", - "url": "/users/{username}/received_events", - "isDeprecated": false, - "deprecationDate": null, - "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-events-received-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "List public events received by a user", - "scope": "activity", - "id": "listReceivedPublicEventsForUser", - "method": "GET", - "url": "/users/{username}/received_events/public", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-public-events-received-by-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "List repository events", - "scope": "activity", - "id": "listRepoEvents", - "method": "GET", - "url": "/repos/{owner}/{repo}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-repository-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "List repository notifications for the authenticated user", - "scope": "activity", - "id": "listRepoNotificationsForAuthenticatedUser", - "method": "GET", - "url": "/repos/{owner}/{repo}/notifications", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all notifications for the current user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-repository-notifications-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "all", - "description": "If `true`, show notifications marked as read.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "participating", - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories starred by the authenticated user", - "scope": "activity", - "id": "listReposStarredByAuthenticatedUser", - "method": "GET", - "url": "/user/starred", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/overview/media-types/) via the `Accept` header:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-repositories-starred-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" - } - ] - }, - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List repositories starred by a user", - "scope": "activity", - "id": "listReposStarredByUser", - "method": "GET", - "url": "/users/{username}/starred", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/overview/media-types/) via the `Accept` header:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-repositories-starred-by-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories watched by a user", - "scope": "activity", - "id": "listReposWatchedByUser", - "method": "GET", - "url": "/users/{username}/subscriptions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists repositories a user is watching.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-repositories-watched-by-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List stargazers", - "scope": "activity", - "id": "listStargazersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/stargazers", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/overview/media-types/) via the `Accept` header:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-stargazers", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - }, - { - "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List repositories watched by the authenticated user", - "scope": "activity", - "id": "listWatchedReposForAuthenticatedUser", - "method": "GET", - "url": "/user/subscriptions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists repositories the authenticated user is watching.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-repositories-watched-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List watchers", - "scope": "activity", - "id": "listWatchersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/subscribers", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people watching the specified repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-watchers", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Mark notifications as read", - "scope": "activity", - "id": "markNotificationsAsRead", - "method": "PUT", - "url": "/notifications", - "isDeprecated": false, - "deprecationDate": null, - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#mark-notifications-as-read", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "last_read_at", - "description": "Describes the last point that notifications were checked.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "read", - "description": "Whether the notification has been read.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Response", "examples": null }, - { "code": 205, "description": "Reset Content", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Mark repository notifications as read", - "scope": "activity", - "id": "markRepoNotificationsAsRead", - "method": "PUT", - "url": "/repos/{owner}/{repo}/notifications", - "isDeprecated": false, - "deprecationDate": null, - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.0/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#mark-repository-notifications-as-read", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "last_read_at", - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Response", "examples": null }, - { "code": 205, "description": "Reset Content", "examples": null } - ], - "renamed": null - }, - { - "name": "Mark a thread as read", - "scope": "activity", - "id": "markThreadAsRead", - "method": "PATCH", - "url": "/notifications/threads/{thread_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#mark-a-thread-as-read", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "thread_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 205, "description": "Reset Content", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Set a repository subscription", - "scope": "activity", - "id": "setRepoSubscription", - "method": "PUT", - "url": "/repos/{owner}/{repo}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.0/rest/reference/activity#delete-a-repository-subscription) completely.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#set-a-repository-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "subscribed", - "description": "Determines if notifications should be received from this repository.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ignored", - "description": "Determines if all notifications should be blocked from this repository.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set a thread subscription", - "scope": "activity", - "id": "setThreadSubscription", - "method": "PUT", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.0/rest/reference/activity#delete-a-thread-subscription) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#set-a-thread-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "thread_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ignored", - "description": "Whether to block all notifications from a thread.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Star a repository for the authenticated user", - "scope": "activity", - "id": "starRepoForAuthenticatedUser", - "method": "PUT", - "url": "/user/starred/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#star-a-repository-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unstar a repository for the authenticated user", - "scope": "activity", - "id": "unstarRepoForAuthenticatedUser", - "method": "DELETE", - "url": "/user/starred/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/activity#unstar-a-repository-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Add a repository to an app installation", - "scope": "apps", - "id": "addRepoToInstallation", - "method": "PUT", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.0/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#add-a-repository-to-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "installation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Check an authorization", - "scope": "apps", - "id": "checkAuthorization", - "method": "GET", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#check-an-authorization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Check a token", - "scope": "apps", - "id": "checkToken", - "method": "POST", - "url": "/applications/{client_id}/token", - "isDeprecated": false, - "deprecationDate": null, - "description": "OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#check-a-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The access_token of the OAuth application.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a content attachment", - "scope": "apps", - "id": "createContentAttachment", - "method": "POST", - "url": "/content_references/{content_reference_id}/attachments", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Deprecated:** use `apps.createContentAttachmentForRepo()` (`POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments`) instead. Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-content-attachment", - "previews": [{ "name": "corsair" }], - "headers": [], - "parameters": [ - { - "name": "content_reference_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":101,\"title\":\"[A-1234] Error found in core/models.py file'\",\"body\":\"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a content attachment", - "scope": "apps", - "id": "createContentAttachmentForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.0/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#create-a-content-attachment", - "previews": [{ "name": "corsair" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "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. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":101,\"title\":\"[A-1234] Error found in core/models.py file'\",\"body\":\"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a GitHub App from a manifest", - "scope": "apps", - "id": "createFromManifest", - "method": "POST", - "url": "/app-manifests/{code}/conversions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#create-a-github-app-from-a-manifest", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "code", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDxOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"],\"client_id\":\"Iv1.8a61f9b3a7aba766\",\"client_secret\":\"1726be1638095a19edd134c77bde3aa2ece1e5d8\",\"webhook_secret\":\"e340154128314309424b7c8e90325147d99fdafa\",\"pem\":\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\\n-----END RSA PRIVATE KEY-----\\n\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create an installation access token for an app", - "scope": "apps", - "id": "createInstallationAccessToken", - "method": "POST", - "url": "/app/installations/{installation_id}/access_tokens", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps/#create-an-installation-access-token-for-an-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "installation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repositories", - "description": "List of repository names that the token should have access to", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_ids", - "description": "List of repository IDs that the token should have access to", - "in": "BODY", - "type": "integer[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions", - "description": "The permissions granted to the user-to-server access token.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.actions", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.administration", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.checks", - "description": "The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.content_references", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`.", - "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. Can be one of: `read` or `write`.", - "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. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.environments", - "description": "The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.issues", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.metadata", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.packages", - "description": "The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.pages", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.pull_requests", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`.", - "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. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.repository_projects", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.secret_scanning_alerts", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.secrets", - "description": "The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.security_events", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.single_file", - "description": "The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.statuses", - "description": "The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.vulnerability_alerts", - "description": "The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.workflows", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.members", - "description": "The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_administration", - "description": "The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_plan", - "description": "The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_projects", - "description": "The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_packages", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_secrets", - "description": "The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_self_hosted_runners", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_user_blocking", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.team_discussions", - "description": "The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"ghs_16C7e42F292c6912E7710c838347Ae178B4a\",\"expires_at\":\"2016-07-11T22:14:10Z\",\"permissions\":{\"issues\":\"write\",\"contents\":\"read\"},\"repository_selection\":\"selected\",\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an app authorization", - "scope": "apps", - "id": "deleteAuthorization", - "method": "DELETE", - "url": "/applications/{client_id}/grant", - "isDeprecated": false, - "deprecationDate": null, - "description": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#delete-an-app-authorization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The OAuth access token used to authenticate to the GitHub API.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an installation for the authenticated app", - "scope": "apps", - "id": "deleteInstallation", - "method": "DELETE", - "url": "/app/installations/{installation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-server@3.0/rest/reference/apps/#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#delete-an-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "installation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an app token", - "scope": "apps", - "id": "deleteToken", - "method": "DELETE", - "url": "/applications/{client_id}/token", - "isDeprecated": false, - "deprecationDate": null, - "description": "OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#delete-an-app-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The OAuth access token used to authenticate to the GitHub API.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the authenticated app", - "scope": "apps", - "id": "getAuthenticated", - "method": "GET", - "url": "/app", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.0/rest/reference/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#get-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an app", - "scope": "apps", - "id": "getBySlug", - "method": "GET", - "url": "/apps/{app_slug}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps/#get-an-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "app_slug", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an installation for the authenticated app", - "scope": "apps", - "id": "getInstallation", - "method": "GET", - "url": "/app/installations/{installation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables an authenticated GitHub App to find an installation's information using the installation id. The installation's account type (`target_type`) will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#get-an-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "installation_id parameter", - "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\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"selected\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an organization installation for the authenticated app", - "scope": "apps", - "id": "getOrgInstallation", - "method": "GET", - "url": "/orgs/{org}/installation", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/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/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository installation for the authenticated app", - "scope": "apps", - "id": "getRepoInstallation", - "method": "GET", - "url": "/repos/{owner}/{repo}/installation", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/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/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a user installation for the authenticated app", - "scope": "apps", - "id": "getUserInstallation", - "method": "GET", - "url": "/users/{username}/installation", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#get-a-user-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/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/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a webhook configuration for an app", - "scope": "apps", - "id": "getWebhookConfigForApp", - "method": "GET", - "url": "/app/hook/config", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#get-a-webhook-configuration-for-an-app", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories accessible to the user access token", - "scope": "apps", - "id": "listInstallationReposForAuthenticatedUser", - "method": "GET", - "url": "/user/installations/{installation_id}/repositories", - "isDeprecated": false, - "deprecationDate": 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-to-server OAuth access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#list-repositories-accessible-to-the-user-access-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "installation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The access the user has to each repository is included in the hash under the `permissions` key.", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List installations for the authenticated app", - "scope": "apps", - "id": "listInstallations", - "method": "GET", - "url": "/app/installations", - "isDeprecated": false, - "deprecationDate": null, - "description": "You must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#list-installations-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "outdated", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The permissions the installation has are included under the `permissions` key.", - "examples": [ - { - "data": "[{\"id\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"selected\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List app installations accessible to the user access token", - "scope": "apps", - "id": "listInstallationsForAuthenticatedUser", - "method": "GET", - "url": "/user/installations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "You can find the permissions for the installation under the `permissions` key.", - "examples": [ - { - "data": "{\"total_count\":2,\"installations\":[{\"id\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null},{\"id\":3,\"account\":{\"login\":\"octocat\",\"id\":2,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "List repositories accessible to the app installation", - "scope": "apps", - "id": "listReposAccessibleToInstallation", - "method": "GET", - "url": "/installation/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "List repositories that an app installation can access.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#list-repositories-accessible-to-the-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove a repository from an app installation", - "scope": "apps", - "id": "removeRepoFromInstallation", - "method": "DELETE", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.0/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#remove-a-repository-from-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "installation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Reset an authorization", - "scope": "apps", - "id": "resetAuthorization", - "method": "POST", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#reset-an-authorization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"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}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Reset a token", - "scope": "apps", - "id": "resetToken", - "method": "PATCH", - "url": "/applications/{client_id}/token", - "isDeprecated": false, - "deprecationDate": null, - "description": "OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#reset-a-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The access_token of the OAuth application.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Revoke an authorization for an application", - "scope": "apps", - "id": "revokeAuthorizationForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#revoke-an-authorization-for-an-application", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "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": "Revoke a grant for an application", - "scope": "apps", - "id": "revokeGrantForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/grants/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub Enterprise Server](https://github.com/settings/applications#authorized).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#revoke-a-grant-for-an-application", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "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": "Revoke an installation access token", - "scope": "apps", - "id": "revokeInstallationAccessToken", - "method": "DELETE", - "url": "/installation/token", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/reference/apps#create-an-installation-access-token-for-an-app)\" endpoint.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#revoke-an-installation-access-token", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Create a scoped access token", - "scope": "apps", - "id": "scopeToken", - "method": "POST", - "url": "/applications/{client_id}/token/scoped", - "isDeprecated": false, - "deprecationDate": null, - "description": "Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#create-a-scoped-access-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of your GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The OAuth access token used to authenticate to the GitHub API.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target", - "description": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_id", - "description": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repositories", - "description": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_ids", - "description": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", - "in": "BODY", - "type": "integer[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions", - "description": "The permissions granted to the user-to-server access token.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.actions", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.administration", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.checks", - "description": "The level of permission to grant the access token for checks on code. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.content_references", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments. Can be one of: `read` or `write`.", - "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. Can be one of: `read` or `write`.", - "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. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.environments", - "description": "The level of permission to grant the access token for managing repository environments. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.issues", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.metadata", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.packages", - "description": "The level of permission to grant the access token for packages published to GitHub Packages. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.pages", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.pull_requests", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges. Can be one of: `read` or `write`.", - "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. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.repository_projects", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.secret_scanning_alerts", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.secrets", - "description": "The level of permission to grant the access token to manage repository secrets. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.security_events", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.single_file", - "description": "The level of permission to grant the access token to manage just a single file. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.statuses", - "description": "The level of permission to grant the access token for commit statuses. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.vulnerability_alerts", - "description": "The level of permission to grant the access token to retrieve Dependabot alerts. Can be one of: `read`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.workflows", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files. Can be one of: `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.members", - "description": "The level of permission to grant the access token for organization teams and members. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_administration", - "description": "The level of permission to grant the access token to manage access to an organization. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_plan", - "description": "The level of permission to grant the access token for viewing an organization's plan. Can be one of: `read`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_projects", - "description": "The level of permission to grant the access token to manage organization projects, columns, and cards. Can be one of: `read`, `write`, or `admin`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_packages", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_secrets", - "description": "The level of permission to grant the access token to manage organization secrets. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_self_hosted_runners", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_user_blocking", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.team_discussions", - "description": "The level of permission to grant the access token to manage team discussions and related comments. Can be one of: `read` or `write`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"installation\":{\"permissions\":{\"metadata\":\"read\",\"issues\":\"write\",\"contents\":\"read\"},\"repository_selection\":\"selected\",\"single_file_name\":\".github/workflow.yml\",\"repositories_url\":\"https://api.github.com/user/repos\",\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"has_multiple_single_files\":false,\"single_file_paths\":[]}}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Suspend an app installation", - "scope": "apps", - "id": "suspendInstallation", - "method": "PUT", - "url": "/app/installations/{installation_id}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#suspend-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "installation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unsuspend an app installation", - "scope": "apps", - "id": "unsuspendInstallation", - "method": "DELETE", - "url": "/app/installations/{installation_id}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#unsuspend-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "installation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a webhook configuration for an app", - "scope": "apps", - "id": "updateWebhookConfigForApp", - "method": "PATCH", - "url": "/app/hook/config", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#update-a-webhook-configuration-for-an-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a check run", - "scope": "checks", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-runs", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": ["queued", "in_progress"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a check suite", - "scope": "checks", - "id": "createSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.0/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/checks#create-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head_sha", - "description": "The sha of the head commit.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "when the suite already existed", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" - } - ] - }, - { - "code": 201, - "description": "Response when the suite was created", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a check run", - "scope": "checks", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/checks#get-a-check-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_run_id", - "description": "check_run_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a check suite", - "scope": "checks", - "id": "getSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/checks#get-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_suite_id", - "description": "check_suite_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List check run annotations", - "scope": "checks", - "id": "listAnnotations", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/checks#list-check-run-annotations", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_run_id", - "description": "check_run_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"path\":\"README.md\",\"start_line\":2,\"end_line\":2,\"start_column\":5,\"end_column\":10,\"annotation_level\":\"warning\",\"title\":\"Spell Checker\",\"message\":\"Check your spelling for 'banaas'.\",\"raw_details\":\"Do you mean 'bananas' or 'banana'?\",\"blob_href\":\"https://api.github.com/repos/github/rest-api-description/git/blobs/abc\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List check runs for a Git reference", - "scope": "checks", - "id": "listForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/checks#list-check-runs-for-a-git-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["queued", "in_progress", "completed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["latest", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "app_id", - "description": "", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List check runs in a check suite", - "scope": "checks", - "id": "listForSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/checks#list-check-runs-in-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_suite_id", - "description": "check_suite_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["queued", "in_progress", "completed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["latest", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List check suites for a Git reference", - "scope": "checks", - "id": "listSuitesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/checks#list-check-suites-for-a-git-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "app_id", - "description": "Filters check suites by GitHub App `id`.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"check_suites\":[{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Rerequest a check suite", - "scope": "checks", - "id": "rerequestSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/checks#rerequest-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_suite_id", - "description": "check_suite_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 201, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Update repository preferences for check suites", - "scope": "checks", - "id": "setSuitesPreferences", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-suites/preferences", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.0/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/checks#update-repository-preferences-for-check-suites", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_trigger_checks", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#auto_trigger_checks-object) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_trigger_checks[].app_id", - "description": "The `id` of the GitHub App.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_trigger_checks[].setting", - "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"preferences\":{\"auto_trigger_checks\":[{\"app_id\":2,\"setting\":true},{\"app_id\":4,\"setting\":false}]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a check run", - "scope": "checks", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/checks#update-a-check-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_run_id", - "description": "check_run_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the check. For example, \"code-coverage\".", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "details_url", - "description": "The URL of the integrator's site that has the full details of the check.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "external_id", - "description": "A reference for the run on the integrator's system.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "started_at", - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["queued", "in_progress", "completed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "conclusion", - "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `action_required`, `cancelled`, `failure`, `neutral`, `success`, `skipped`, `stale`, or `timed_out`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "in": "BODY", - "type": "string", - "required": false, - "enum": [ - "action_required", - "cancelled", - "failure", - "neutral", - "success", - "skipped", - "stale", - "timed_out" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "completed_at", - "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#output-object-1) description.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.title", - "description": "**Required**.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.summary", - "description": "Can contain Markdown.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.text", - "description": "Can contain Markdown.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#annotations-object-1) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].path", - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].start_line", - "description": "The start line of the annotation.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].end_line", - "description": "The end line of the annotation.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].start_column", - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].end_column", - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].annotation_level", - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["notice", "warning", "failure"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].message", - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].title", - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].raw_details", - "description": "Details about this annotation. The maximum size is 64 KB.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.images", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#annotations-object-1) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.images[].alt", - "description": "The alternative text for the image.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.images[].image_url", - "description": "The full URL of the image.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.images[].caption", - "description": "A short image description.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actions", - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.0/rest/reference/checks#check-runs-and-requested-actions).\"", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actions[].label", - "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actions[].description", - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actions[].identifier", - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a code scanning alert", - "scope": "codeScanning", - "id": "getAlert", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/code-scanning#get-a-code-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"number\":42,\"created_at\":\"2020-06-19T11:21:34Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/42\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":54933897,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"security_severity_level\":\"high\",\"description\":\"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\"name\":\"js/zipslip\",\"full_description\":\"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"help\":\"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"dismissed\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\",\"instances\":null}" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List code scanning alerts for a repository", - "scope": "codeScanning", - "id": "listAlertsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_guid", - "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "dismissed", "fixed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"number\":4,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/4\",\"state\":\"open\",\"dismissed_by\":null,\"dismissed_at\":null,\"dismissed_reason\":null,\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances\"},{\"number\":3,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/3\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances\"}]" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List code scanning analyses for a repository", - "scope": "codeScanning", - "id": "listRecentAnalyses", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/analyses", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_guid", - "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sarif_id", - "description": "Filter analyses belonging to the same SARIF upload.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"ref\":\"refs/heads/main\",\"commit_sha\":\"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:analyze\",\"environment\":\"{\\\"language\\\":\\\"python\\\"}\",\"error\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:analyze/language:python\",\"created_at\":\"2020-08-27T15:05:21Z\",\"results_count\":17,\"rules_count\":49,\"id\":201,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\"sarif_id\":\"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"deletable\":true,\"warning\":\"\"},{\"ref\":\"refs/heads/my-branch\",\"commit_sha\":\"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\"analysis_key\":\".github/workflows/shiftleft.yml:build\",\"environment\":\"{}\",\"error\":\"\",\"category\":\".github/workflows/shiftleft.yml:build/\",\"created_at\":\"2020-08-31T22:46:44Z\",\"results_count\":17,\"rules_count\":32,\"id\":200,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\"sarif_id\":\"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\"tool\":{\"name\":\"Python Security Analysis\",\"guid\":null,\"version\":\"1.2.0\"},\"deletable\":true,\"warning\":\"\"}]" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a code scanning alert", - "scope": "codeScanning", - "id": "updateAlert", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/code-scanning#update-a-code-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["open", "dismissed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissed_reason", - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": [null, "false positive", "won't fix", "used in tests"], - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"number\":42,\"created_at\":\"2020-08-25T21:28:36Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/42\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-09-02T22:34:56Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"security_severity_level\":\"high\",\"description\":\"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\"name\":\"js/zipslip\",\"full_description\":\"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"help\":\"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"dismissed\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"}" - } - ] - }, - { - "code": 403, - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Upload an analysis as SARIF data", - "scope": "codeScanning", - "id": "uploadSarif", - "method": "POST", - "url": "/repos/{owner}/{repo}/code-scanning/sarifs", - "isDeprecated": false, - "deprecationDate": null, - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/code-scanning#upload-a-sarif-file", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit to which the analysis you are uploading relates.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^[0-9a-fA-F]+$", - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sarif", - "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.0/code-security/secure-coding/sarif-support-for-code-scanning).\"", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "checkout_uri", - "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "started_at", - "description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_name", - "description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"id\":\"47177e22-5596-11eb-80a1-c1e54ef945c6\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6\"}" - } - ] - }, - { - "code": 400, - "description": "Bad Request if the sarif field is invalid", - "examples": null - }, - { - "code": 403, - "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 413, - "description": "Payload Too Large if the sarif field is too large", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all codes of conduct", - "scope": "codesOfConduct", - "id": "getAllCodesOfConduct", - "method": "GET", - "url": "/codes_of_conduct", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/codes-of-conduct#get-all-codes-of-conduct", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"citizen_code_of_conduct\",\"name\":\"Citizen Code of Conduct\",\"url\":\"https://api.github.com/codes_of_conduct/citizen_code_of_conduct\",\"html_url\":\"http://citizencodeofconduct.org/\"},{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"html_url\":\"https://www.contributor-covenant.org/version/2/0/code_of_conduct/\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a code of conduct", - "scope": "codesOfConduct", - "id": "getConductCode", - "method": "GET", - "url": "/codes_of_conduct/{key}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/codes-of-conduct#get-a-code-of-conduct", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\n to any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\",\"html_url\":\"http://contributor-covenant.org/version/1/4/\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get emojis", - "scope": "emojis", - "id": "get", - "method": "GET", - "url": "/emojis", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all the emojis available to use on GitHub Enterprise Server.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/emojis#get-emojis", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Add an authorized SSH key", - "scope": "enterpriseAdmin", - "id": "addAuthorizedSshKey", - "method": "POST", - "url": "/setup/api/settings/authorized-keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#add-an-authorized-ssh-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "authorized_key", - "description": "The public SSH key.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a GitHub license", - "scope": "enterpriseAdmin", - "id": "createEnterpriseServerLicense", - "method": "POST", - "url": "/setup/api/start", - "isDeprecated": false, - "deprecationDate": null, - "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#create-a-github-enterprise-server-license", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "license", - "description": "The content of your _.ghl_ license file.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "password", - "description": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "settings", - "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 202, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Create a global webhook", - "scope": "enterpriseAdmin", - "id": "createGlobalWebhook", - "method": "POST", - "url": "/admin/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#create-a-global-webhook", - "previews": [{ "name": "superpro" }], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "Must be passed as \"web\".", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#delivery-headers) header.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "events", - "description": "The [events](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\",\"user\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create an impersonation OAuth token", - "scope": "enterpriseAdmin", - "id": "createImpersonationOAuthToken", - "method": "POST", - "url": "/admin/users/{username}/authorizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#create-an-impersonation-oauth-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "scopes", - "description": "A list of [scopes](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create an organization", - "scope": "enterpriseAdmin", - "id": "createOrg", - "method": "POST", - "url": "/admin/organizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#create-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "login", - "description": "The organization's username.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "admin", - "description": "The login of the user who will manage this organization.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "profile_name", - "description": "The organization's display name.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "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\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "createPreReceiveEnvironment", - "method": "POST", - "url": "/admin/pre-receive-environments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#create-a-pre-receive-environment", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "The new pre-receive environment's name.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "image_url", - "description": "URL from which to download a tarball of this environment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":null,\"message\":null}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a pre-receive hook", - "scope": "enterpriseAdmin", - "id": "createPreReceiveHook", - "method": "POST", - "url": "/admin/pre-receive-hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#create-a-pre-receive-hook", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "The name of the hook.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script", - "description": "The script that the hook runs.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script_repository", - "description": "The GitHub repository where the script is kept.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script_repository.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "The pre-receive environment where the script is executed.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforcement", - "description": "The state of enforcement for this hook. default: `disabled`", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_downstream_configuration", - "description": "Whether enforcement can be overridden at the org or repo level. default: `false`", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a user", - "scope": "enterpriseAdmin", - "id": "createUser", - "method": "POST", - "url": "/admin/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#create-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "login", - "description": "The user's username.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "email", - "description": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub authentication guide](https://help.github.com/enterprise/2.18/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a global webhook", - "scope": "enterpriseAdmin", - "id": "deleteGlobalWebhook", - "method": "DELETE", - "url": "/admin/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#delete-a-global-webhook", - "previews": [{ "name": "superpro" }], - "headers": [], - "parameters": [ - { - "name": "hook_id", - "description": "", - "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 impersonation OAuth token", - "scope": "enterpriseAdmin", - "id": "deleteImpersonationOAuthToken", - "method": "DELETE", - "url": "/admin/users/{username}/authorizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#delete-an-impersonation-oauth-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "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": "Delete a personal access token", - "scope": "enterpriseAdmin", - "id": "deletePersonalAccessToken", - "method": "DELETE", - "url": "/admin/tokens/{token_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#delete-a-personal-access-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "token_id", - "description": "", - "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 a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "deletePreReceiveEnvironment", - "method": "DELETE", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Cannot delete environment that has hooks_\n* _Cannot delete environment when download is in progress_", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#delete-a-pre-receive-environment", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "", - "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": 422, - "description": "Client Errors", - "examples": [ - { - "data": "{\"message\":\"Validation Failed\",\"errors\":[{\"resource\":\"PreReceiveEnvironment\",\"code\":\"custom\",\"message\":\"Cannot modify or delete the default environment\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a pre-receive hook", - "scope": "enterpriseAdmin", - "id": "deletePreReceiveHook", - "method": "DELETE", - "url": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#delete-a-pre-receive-hook", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "pre_receive_hook_id parameter", - "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 a public key", - "scope": "enterpriseAdmin", - "id": "deletePublicKey", - "method": "DELETE", - "url": "/admin/keys/{key_ids}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#delete-a-public-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_ids", - "description": "", - "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": "Delete a user", - "scope": "enterpriseAdmin", - "id": "deleteUser", - "method": "DELETE", - "url": "/admin/users/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#delete-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "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": "Demote a site administrator", - "scope": "enterpriseAdmin", - "id": "demoteSiteAdministrator", - "method": "DELETE", - "url": "/users/{username}/site_admin", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can demote any user account except your own.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#demote-a-site-administrator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "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": "Disable a selected organization for GitHub Actions in an enterprise", - "scope": "enterpriseAdmin", - "id": "disableSelectedOrganizationGithubActionsEnterprise", - "method": "DELETE", - "url": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "org_id", - "description": "Unique identifier of an organization.", - "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": "Enable or disable maintenance mode", - "scope": "enterpriseAdmin", - "id": "enableOrDisableMaintenanceMode", - "method": "POST", - "url": "/setup/api/maintenance", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#enable-or-disable-maintenance-mode", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "maintenance", - "description": "A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"status\":\"scheduled\",\"scheduled_time\":\"Tuesday, January 22 at 15:34 -0800\",\"connection_services\":[{\"name\":\"git operations\",\"number\":0},{\"name\":\"mysql queries\",\"number\":233},{\"name\":\"resque jobs\",\"number\":54}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Enable a selected organization for GitHub Actions in an enterprise", - "scope": "enterpriseAdmin", - "id": "enableSelectedOrganizationGithubActionsEnterprise", - "method": "PUT", - "url": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "org_id", - "description": "Unique identifier of an organization.", - "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": "Get all authorized SSH keys", - "scope": "enterpriseAdmin", - "id": "getAllAuthorizedSshKeys", - "method": "GET", - "url": "/setup/api/settings/authorized-keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-all-authorized-ssh-keys", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get all statistics", - "scope": "enterpriseAdmin", - "id": "getAllStats", - "method": "GET", - "url": "/enterprise/stats/all", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"repos\":{\"total_repos\":212,\"root_repos\":194,\"fork_repos\":18,\"org_repos\":51,\"total_pushes\":3082,\"total_wikis\":15},\"hooks\":{\"total_hooks\":27,\"active_hooks\":23,\"inactive_hooks\":4},\"pages\":{\"total_pages\":36},\"orgs\":{\"total_orgs\":33,\"disabled_orgs\":0,\"total_teams\":60,\"total_team_members\":314},\"users\":{\"total_users\":254,\"admin_users\":45,\"suspended_users\":21},\"pulls\":{\"total_pulls\":86,\"merged_pulls\":60,\"mergeable_pulls\":21,\"unmergeable_pulls\":3},\"issues\":{\"total_issues\":179,\"open_issues\":83,\"closed_issues\":96},\"milestones\":{\"total_milestones\":7,\"open_milestones\":6,\"closed_milestones\":1},\"gists\":{\"total_gists\":178,\"private_gists\":151,\"public_gists\":25},\"comments\":{\"total_commit_comments\":6,\"total_gist_comments\":28,\"total_issue_comments\":366,\"total_pull_request_comments\":30}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get gist statistics", - "scope": "enterpriseAdmin", - "id": "getAllStats", - "method": "GET", - "url": "/enterprise/stats/gists", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-gist-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get allowed actions for an enterprise", - "scope": "enterpriseAdmin", - "id": "getAllowedActionsEnterprise", - "method": "GET", - "url": "/enterprises/{enterprise}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the global announcement banner", - "scope": "enterpriseAdmin", - "id": "getAnnouncement", - "method": "GET", - "url": "/enterprise/announcement", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the current message and expiration date of the global announcement banner in your enterprise.", - "documentationUrl": "", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"announcement\":\"Very **important** announcement about _nothing_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get comment statistics", - "scope": "enterpriseAdmin", - "id": "getCommentStats", - "method": "GET", - "url": "/enterprise/stats/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-comment-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get the configuration status", - "scope": "enterpriseAdmin", - "id": "getConfigurationStatus", - "method": "GET", - "url": "/setup/api/configcheck", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status | Description |\n| ------------- | --------------------------------- |\n| `PENDING` | The job has not started yet |\n| `CONFIGURING` | The job is running |\n| `DONE` | The job has finished correctly |\n| `FAILED` | The job has finished unexpectedly |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-the-configuration-status", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"status\":\"running\",\"progress\":[{\"status\":\"DONE\",\"key\":\"Appliance core components\"},{\"status\":\"DONE\",\"key\":\"GitHub utilities\"},{\"status\":\"DONE\",\"key\":\"GitHub applications\"},{\"status\":\"CONFIGURING\",\"key\":\"GitHub services\"},{\"status\":\"PENDING\",\"key\":\"Reloading appliance services\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the download status for a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "getDownloadStatusForPreReceiveEnvironment", - "method": "GET", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - "isDeprecated": false, - "deprecationDate": null, - "description": "In addition to seeing the download status at the \"[Get a pre-receive environment](#get-a-pre-receive-environment)\" endpoint, there is also this separate endpoint for just the download status.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-the-download-status-for-a-pre-receive-environment", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get GitHub Actions permissions for an enterprise", - "scope": "enterpriseAdmin", - "id": "getGithubActionsPermissionsEnterprise", - "method": "GET", - "url": "/enterprises/{enterprise}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"enabled_organizations\":\"all\",\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/enterprises/2/actions/permissions/selected-actions\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a global webhook", - "scope": "enterpriseAdmin", - "id": "getGlobalWebhook", - "method": "GET", - "url": "/admin/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-a-global-webhook", - "previews": [{ "name": "superpro" }], - "headers": [], - "parameters": [ - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\",\"user\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get hooks statistics", - "scope": "enterpriseAdmin", - "id": "getHooksStats", - "method": "GET", - "url": "/enterprise/stats/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-hooks-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get issue statistics", - "scope": "enterpriseAdmin", - "id": "getIssueStats", - "method": "GET", - "url": "/enterprise/stats/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-issues-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get license information", - "scope": "enterpriseAdmin", - "id": "getLicenseInformation", - "method": "GET", - "url": "/enterprise/settings/license", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-license-information", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"seats\":1400,\"seats_used\":1316,\"seats_available\":84,\"kind\":\"standard\",\"days_until_expiration\":365,\"expire_at\":\"2016/02/06 12:41:52 -0600\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the maintenance status", - "scope": "enterpriseAdmin", - "id": "getMaintenanceStatus", - "method": "GET", - "url": "/setup/api/maintenance", - "isDeprecated": false, - "deprecationDate": null, - "description": "Check your installation's maintenance status:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-the-maintenance-status", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"status\":\"scheduled\",\"scheduled_time\":\"Tuesday, January 22 at 15:34 -0800\",\"connection_services\":[{\"name\":\"git operations\",\"number\":0},{\"name\":\"mysql queries\",\"number\":233},{\"name\":\"resque jobs\",\"number\":54}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get milestone statistics", - "scope": "enterpriseAdmin", - "id": "getMilestoneStats", - "method": "GET", - "url": "/enterprise/stats/milestones", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-milestone-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get organization statistics", - "scope": "enterpriseAdmin", - "id": "getOrgStats", - "method": "GET", - "url": "/enterprise/stats/orgs", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-organization-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get pages statistics", - "scope": "enterpriseAdmin", - "id": "getPagesStats", - "method": "GET", - "url": "/enterprise/stats/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-pages-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "getPreReceiveEnvironment", - "method": "GET", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-a-pre-receive-environment", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":null,\"message\":null}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a pre-receive hook", - "scope": "enterpriseAdmin", - "id": "getPreReceiveHook", - "method": "GET", - "url": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-a-pre-receive-hook", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "pre_receive_hook_id parameter", - "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\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a pre-receive hook for an organization", - "scope": "enterpriseAdmin", - "id": "getPreReceiveHookForOrg", - "method": "GET", - "url": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "pre_receive_hook_id parameter", - "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\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\"allow_downstream_configuration\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a pre-receive hook for a repository", - "scope": "enterpriseAdmin", - "id": "getPreReceiveHookForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "pre_receive_hook_id parameter", - "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\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get pull request statistics", - "scope": "enterpriseAdmin", - "id": "getPullRequestStats", - "method": "GET", - "url": "/enterprise/stats/pulls", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-pull-requests-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get repository statistics", - "scope": "enterpriseAdmin", - "id": "getRepoStats", - "method": "GET", - "url": "/enterprise/stats/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-repository-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get settings", - "scope": "enterpriseAdmin", - "id": "getSettings", - "method": "GET", - "url": "/setup/api/settings", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"enterprise\":{\"private_mode\":false,\"public_pages\":false,\"subdomain_isolation\":true,\"signup_enabled\":false,\"github_hostname\":\"ghe.local\",\"identicons_host\":\"dotcom\",\"http_proxy\":null,\"auth_mode\":\"default\",\"expire_sessions\":false,\"admin_password\":null,\"configuration_id\":1401777404,\"configuration_run_count\":4,\"avatar\":{\"enabled\":false,\"uri\":\"\"},\"customer\":{\"name\":\"GitHub\",\"email\":\"stannis@themannis.biz\",\"uuid\":\"af6cac80-e4e1-012e-d822-1231380e52e9\",\"secret_key_data\":\"-----BEGIN PGP PRIVATE KEY BLOCK-----\\nVersion: GnuPG v1.4.10 (GNU/Linux)\\n\\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\\n-----END PGP PRIVATE KEY BLOCK-----\\n\",\"public_key_data\":\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v1.4.10 (GNU/Linux)\\n\\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\\n-----END PGP PUBLIC KEY BLOCK-----\\n\"},\"license\":{\"seats\":0,\"evaluation\":false,\"perpetual\":false,\"unlimited_seating\":true,\"support_key\":\"ssh-rsa AAAAB3N....\",\"ssh_allowed\":true,\"cluster_support\":false,\"expire_at\":\"2016-04-27T00:00:00-07:00\"},\"github_ssl\":{\"enabled\":false,\"cert\":null,\"key\":null},\"ldap\":{\"host\":null,\"port\":0,\"base\":[],\"uid\":null,\"bind_dn\":null,\"password\":null,\"method\":\"Plain\",\"search_strategy\":\"detect\",\"user_groups\":[],\"admin_group\":null,\"virtual_attribute_enabled\":false,\"recursive_group_search\":false,\"posix_support\":true,\"user_sync_emails\":false,\"user_sync_keys\":false,\"user_sync_interval\":4,\"team_sync_interval\":4,\"sync_enabled\":false,\"reconciliation\":{\"user\":null,\"org\":null},\"profile\":{\"uid\":\"uid\",\"name\":null,\"mail\":null,\"key\":null}},\"cas\":{\"url\":null},\"saml\":{\"sso_url\":null,\"certificate\":null,\"certificate_path\":null,\"issuer\":null,\"idp_initiated_sso\":false,\"disable_admin_demote\":false},\"github_oauth\":{\"client_id\":\"12313412\",\"client_secret\":\"kj123131132\",\"organization_name\":\"Homestar Runners\",\"organization_team\":\"homestarrunners/characters\"},\"smtp\":{\"enabled\":true,\"address\":\"smtp.example.com\",\"authentication\":\"plain\",\"port\":\"1234\",\"domain\":\"blah\",\"username\":\"foo\",\"user_name\":\"mr_foo\",\"enable_starttls_auto\":true,\"password\":\"bar\",\"discard-to-noreply-address\":true,\"support_address\":\"enterprise@github.com\",\"support_address_type\":\"email\",\"noreply_address\":\"noreply@github.com\"},\"ntp\":{\"primary_server\":\"0.pool.ntp.org\",\"secondary_server\":\"1.pool.ntp.org\"},\"timezone\":null,\"snmp\":{\"enabled\":false,\"community\":\"\"},\"syslog\":{\"enabled\":false,\"server\":null,\"protocol_name\":\"udp\"},\"assets\":null,\"pages\":{\"enabled\":true},\"collectd\":{\"enabled\":false,\"server\":null,\"port\":0,\"encryption\":null,\"username\":null,\"password\":null},\"mapping\":{\"enabled\":true,\"tileserver\":null,\"basemap\":\"company.map-qsz2zrvs\",\"token\":null},\"load_balancer\":null},\"run_list\":[\"recipe[enterprise-configure]\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get users statistics", - "scope": "enterpriseAdmin", - "id": "getUserStats", - "method": "GET", - "url": "/enterprise/stats/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-users-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "List global webhooks", - "scope": "enterpriseAdmin", - "id": "listGlobalWebhooks", - "method": "GET", - "url": "/admin/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#list-global-webhooks", - "previews": [{ "name": "superpro" }], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\",\"user\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List personal access tokens", - "scope": "enterpriseAdmin", - "id": "listPersonalAccessTokens", - "method": "GET", - "url": "/admin/tokens", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists personal access tokens for all users, including admin users.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#list-personal-access-tokens", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":2,\"url\":\"https://enterprise.octocat.com/api/v3/authorizations/2\",\"app\":{\"name\":\"My personal access token\",\"url\":\"https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens\",\"client_id\":\"00000000000000000000\"},\"token\":\"ghp_16C7e42F292c6912E7710c838347Ae178B4a\",\"hashed_token\":\"23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45\",\"token_last_eight\":\"Ae178B4a\",\"note\":\"My personal access token\",\"note_url\":null,\"created_at\":\"2019-04-24T21:49:02Z\",\"updated_at\":\"2019-04-24T21:49:02Z\",\"scopes\":[\"admin:business\",\"admin:gpg_key\",\"admin:org\",\"admin:org_hook\",\"admin:pre_receive_hook\",\"admin:public_key\",\"admin:repo_hook\",\"delete_repo\",\"gist\",\"notifications\",\"repo\",\"user\",\"write:discussion\"],\"fingerprint\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pre-receive environments", - "scope": "enterpriseAdmin", - "id": "listPreReceiveEnvironments", - "method": "GET", - "url": "/admin/pre-receive-environments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#list-pre-receive-environments", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"name\":\"Default\",\"image_url\":\"githubenterprise://internal\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/1\",\"default_environment\":true,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":14,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pre-receive hooks", - "scope": "enterpriseAdmin", - "id": "listPreReceiveHooks", - "method": "GET", - "url": "/admin/pre-receive-hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#list-pre-receive-hooks", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to) or `name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pre-receive hooks for an organization", - "scope": "enterpriseAdmin", - "id": "listPreReceiveHooksForOrg", - "method": "GET", - "url": "/orgs/{org}/pre-receive-hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The sort order for the response collection.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\"allow_downstream_configuration\":true}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pre-receive hooks for a repository", - "scope": "enterpriseAdmin", - "id": "listPreReceiveHooksForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/pre-receive-hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public keys", - "scope": "enterpriseAdmin", - "id": "listPublicKeys", - "method": "GET", - "url": "/admin/keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#list-public-keys", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "accessed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show public keys accessed after the given time.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false,\"last_used\":\"2020-06-11T22:31:57Z\",\"user_id\":1,\"repository_id\":2},{\"key\":\"9Og8iYjAyymI9LvABpJerYrMxURPc8r+dB7TJyvv1234\",\"id\":3,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false,\"last_used\":\"2020-06-11T22:31:57Z\",\"user_id\":1,\"repository_id\":2}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List selected organizations enabled for GitHub Actions in an enterprise", - "scope": "enterpriseAdmin", - "id": "listSelectedOrganizationsEnabledGithubActionsEnterprise", - "method": "GET", - "url": "/enterprises/{enterprise}/actions/permissions/organizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"organizations\":[{\"login\":\"octocat\",\"id\":161335,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"url\":\"https://api.github.com/orgs/octo-org\",\"repos_url\":\"https://api.github.com/orgs/octo-org/repos\",\"events_url\":\"https://api.github.com/orgs/octo-org/events\",\"hooks_url\":\"https://api.github.com/orgs/octo-org/hooks\",\"issues_url\":\"https://api.github.com/orgs/octo-org/issues\",\"members_url\":\"https://api.github.com/orgs/octo-org/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/octo-org/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Ping a global webhook", - "scope": "enterpriseAdmin", - "id": "pingGlobalWebhook", - "method": "POST", - "url": "/admin/hooks/{hook_id}/pings", - "isDeprecated": false, - "deprecationDate": null, - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.0/webhooks/#ping-event) to be sent to the webhook.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#ping-a-global-webhook", - "previews": [{ "name": "superpro" }], - "headers": [], - "parameters": [ - { - "name": "hook_id", - "description": "", - "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": "Promote a user to be a site administrator", - "scope": "enterpriseAdmin", - "id": "promoteUserToBeSiteAdministrator", - "method": "PUT", - "url": "/users/{username}/site_admin", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#promote-a-user-to-be-a-site-administrator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "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 the global announcement banner", - "scope": "enterpriseAdmin", - "id": "removeAnnouncement", - "method": "DELETE", - "url": "/enterprise/announcement", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes the global announcement banner in your enterprise.", - "documentationUrl": "", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove an authorized SSH key", - "scope": "enterpriseAdmin", - "id": "removeAuthorizedSshKey", - "method": "DELETE", - "url": "/setup/api/settings/authorized-keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#remove-an-authorized-ssh-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "authorized_key", - "description": "The public SSH key.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove pre-receive hook enforcement for an organization", - "scope": "enterpriseAdmin", - "id": "removePreReceiveHookEnforcementForOrg", - "method": "DELETE", - "url": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes any overrides for this hook at the org level for this org.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "pre_receive_hook_id parameter", - "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\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\"allow_downstream_configuration\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove pre-receive hook enforcement for a repository", - "scope": "enterpriseAdmin", - "id": "removePreReceiveHookEnforcementForRepo", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes any overridden enforcement on this repository for the specified hook.\n\nResponds with effective values inherited from owner and/or global level.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "pre_receive_hook_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Responds with effective values inherited from owner and/or global level.", - "examples": [ - { - "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set allowed actions for an enterprise", - "scope": "enterpriseAdmin", - "id": "setAllowedActionsEnterprise", - "method": "PUT", - "url": "/enterprises/{enterprise}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "github_owned_allowed", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "patterns_allowed", - "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "in": "BODY", - "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": "Set the global announcement banner", - "scope": "enterpriseAdmin", - "id": "setAnnouncement", - "method": "PATCH", - "url": "/enterprise/announcement", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the message and expiration time for the global announcement banner in your enterprise.", - "documentationUrl": "", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "announcement", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Mastering markdown](https://guides.github.com/features/mastering-markdown/).\"", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "expires_at", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"announcement\":\"Very **important** announcement about _nothing_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set GitHub Actions permissions for an enterprise", - "scope": "enterpriseAdmin", - "id": "setGithubActionsPermissionsEnterprise", - "method": "PUT", - "url": "/enterprises/{enterprise}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enabled_organizations", - "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["all", "none", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allowed_actions", - "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "local_only", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Set selected organizations enabled for GitHub Actions in an enterprise", - "scope": "enterpriseAdmin", - "id": "setSelectedOrganizationsEnabledGithubActionsEnterprise", - "method": "PUT", - "url": "/enterprises/{enterprise}/actions/permissions/organizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_organization_ids", - "description": "List of organization IDs to enable for GitHub Actions.", - "in": "BODY", - "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 settings", - "scope": "enterpriseAdmin", - "id": "setSettings", - "method": "PUT", - "url": "/setup/api/settings", - "isDeprecated": false, - "deprecationDate": null, - "description": "For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings).\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#set-settings", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "settings", - "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#get-settings).", - "in": "BODY", - "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": "Start a configuration process", - "scope": "enterpriseAdmin", - "id": "startConfigurationProcess", - "method": "POST", - "url": "/setup/api/configure", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#start-a-configuration-process", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 202, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Start a pre-receive environment download", - "scope": "enterpriseAdmin", - "id": "startPreReceiveEnvironmentDownload", - "method": "POST", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - "isDeprecated": false, - "deprecationDate": null, - "description": "Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment.\n\nIf a download cannot be triggered, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Can not start a new download when a download is in progress_", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#start-a-pre-receive-environment-download", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":null,\"message\":null}" - } - ] - }, - { - "code": 422, - "description": "Client Errors", - "examples": [ - { - "data": "{\"message\":\"Validation Failed\",\"errors\":[{\"resource\":\"PreReceiveEnvironment\",\"code\":\"custom\",\"message\":\"Can not start a new download when a download is in progress\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Suspend a user", - "scope": "enterpriseAdmin", - "id": "suspendUser", - "method": "PUT", - "url": "/users/{username}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#suspend-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reason", - "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Sync LDAP mapping for a team", - "scope": "enterpriseAdmin", - "id": "syncLdapMappingForTeam", - "method": "POST", - "url": "/admin/ldap/teams/{team_id}/sync", - "isDeprecated": false, - "deprecationDate": null, - "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#sync-ldap-mapping-for-a-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [{ "data": "{\"status\":\"queued\"}" }] - } - ], - "renamed": null - }, - { - "name": "Sync LDAP mapping for a user", - "scope": "enterpriseAdmin", - "id": "syncLdapMappingForUser", - "method": "POST", - "url": "/admin/ldap/users/{username}/sync", - "isDeprecated": false, - "deprecationDate": null, - "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#sync-ldap-mapping-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [{ "data": "{\"status\":\"queued\"}" }] - } - ], - "renamed": null - }, - { - "name": "Unsuspend a user", - "scope": "enterpriseAdmin", - "id": "unsuspendUser", - "method": "DELETE", - "url": "/users/{username}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#unsuspend-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reason", - "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Update a global webhook", - "scope": "enterpriseAdmin", - "id": "updateGlobalWebhook", - "method": "PATCH", - "url": "/admin/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#update-a-global-webhook", - "previews": [{ "name": "superpro" }], - "headers": [], - "parameters": [ - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#delivery-headers) header.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "events", - "description": "The [events](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"form\",\"insecure_ssl\":\"0\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update LDAP mapping for a team", - "scope": "enterpriseAdmin", - "id": "updateLdapMappingForTeam", - "method": "PATCH", - "url": "/admin/ldap/teams/{team_id}/mapping", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.\n\nIf you pass the `hellcat-preview` media type, you can also update the LDAP mapping of a child team.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ldap_dn", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "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": "{\"ldap_dn\":\"cn=Enterprise Ops,ou=teams,dc=github,dc=com\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update LDAP mapping for a user", - "scope": "enterpriseAdmin", - "id": "updateLdapMappingForUser", - "method": "PATCH", - "url": "/admin/ldap/users/{username}/mapping", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ldap_dn", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "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": "{\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\",\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"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\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"twitter_username\":\"monatheoctocat\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"private_gists\":81,\"total_private_repos\":100,\"owned_private_repos\":100,\"disk_usage\":10000,\"collaborators\":8,\"two_factor_authentication\":true,\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"collaborators\":0}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update an organization name", - "scope": "enterpriseAdmin", - "id": "updateOrgName", - "method": "PATCH", - "url": "/admin/organizations/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#update-an-organization-name", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "login", - "description": "The organization's new name.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"message\":\"Job queued to rename organization. It may take a few minutes to complete.\",\"url\":\"https:///api/v3/organizations/1\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "updatePreReceiveEnvironment", - "method": "PATCH", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#update-a-pre-receive-environment", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "This pre-receive environment's new name.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "image_url", - "description": "URL from which to download a tarball of this environment.", - "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\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}}" - } - ] - }, - { - "code": 422, - "description": "Client Errors", - "examples": [ - { - "data": "{\"message\":\"Validation Failed\",\"errors\":[{\"resource\":\"PreReceiveEnvironment\",\"code\":\"custom\",\"message\":\"Cannot modify or delete the default environment\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a pre-receive hook", - "scope": "enterpriseAdmin", - "id": "updatePreReceiveHook", - "method": "PATCH", - "url": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#update-a-pre-receive-hook", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "pre_receive_hook_id parameter", - "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 hook.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script", - "description": "The script that the hook runs.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script_repository", - "description": "The GitHub repository where the script is kept.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script_repository.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "The pre-receive environment where the script is executed.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforcement", - "description": "The state of enforcement for this hook.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_downstream_configuration", - "description": "Whether enforcement can be overridden at the org or repo level.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":1,\"name\":\"Default\",\"image_url\":\"githubenterprise://internal\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/1\",\"default_environment\":true,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update pre-receive hook enforcement for an organization", - "scope": "enterpriseAdmin", - "id": "updatePreReceiveHookEnforcementForOrg", - "method": "PATCH", - "url": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "pre_receive_hook_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforcement", - "description": "The state of enforcement for the hook on this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_downstream_configuration", - "description": "Whether repositories can override enforcement.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"enabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\",\"allow_downstream_configuration\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update pre-receive hook enforcement for a repository", - "scope": "enterpriseAdmin", - "id": "updatePreReceiveHookEnforcementForRepo", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository", - "previews": [{ "name": "eye-scream" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "pre_receive_hook_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforcement", - "description": "The state of enforcement for the hook on this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["enabled", "disabled", "testing"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"enabled\",\"configuration_url\":\"https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update the username for a user", - "scope": "enterpriseAdmin", - "id": "updateUsernameForUser", - "method": "PATCH", - "url": "/admin/users/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#update-the-username-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "login", - "description": "The user's new username.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"message\":\"Job queued to rename user. It may take a few minutes to complete.\",\"url\":\"https://api.github.com/user/1\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Upgrade a license", - "scope": "enterpriseAdmin", - "id": "upgradeLicense", - "method": "POST", - "url": "/setup/api/upgrade", - "isDeprecated": false, - "deprecationDate": null, - "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/enterprise-admin#upgrade-a-license", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "license", - "description": "The content of your new _.ghl_ license file.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 202, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Check if a gist is starred", - "scope": "gists", - "id": "checkIsStarred", - "method": "GET", - "url": "/gists/{gist_id}/star", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#check-if-a-gist-is-starred", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if gist is starred", - "examples": null - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if gist is not starred", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a gist", - "scope": "gists", - "id": "create", - "method": "POST", - "url": "/gists", - "isDeprecated": false, - "deprecationDate": null, - "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#create-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "description", - "description": "Description of the gist", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files", - "description": "Names and content for the files that make up the gist", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*.content", - "description": "Content of the file", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "public", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a gist comment", - "scope": "gists", - "id": "createComment", - "method": "POST", - "url": "/gists/{gist_id}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#create-a-gist-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The comment text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"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},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a gist", - "scope": "gists", - "id": "delete", - "method": "DELETE", - "url": "/gists/{gist_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#delete-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "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 }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a gist comment", - "scope": "gists", - "id": "deleteComment", - "method": "DELETE", - "url": "/gists/{gist_id}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#delete-a-gist-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Fork a gist", - "scope": "gists", - "id": "fork", - "method": "POST", - "url": "/gists/{gist_id}/forks", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note**: This was previously `/gists/:gist_id/fork`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#fork-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a gist", - "scope": "gists", - "id": "get", - "method": "GET", - "url": "/gists/{gist_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#get-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden Gist", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a gist comment", - "scope": "gists", - "id": "getComment", - "method": "GET", - "url": "/gists/{gist_id}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#get-a-gist-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"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},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden Gist", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a gist revision", - "scope": "gists", - "id": "getRevision", - "method": "GET", - "url": "/gists/{gist_id}/{sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#get-a-gist-revision", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List gists for the authenticated user", - "scope": "gists", - "id": "list", - "method": "GET", - "url": "/gists", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#list-gists-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List gist comments", - "scope": "gists", - "id": "listComments", - "method": "GET", - "url": "/gists/{gist_id}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#list-gist-comments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"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},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List gist commits", - "scope": "gists", - "id": "listCommits", - "method": "GET", - "url": "/gists/{gist_id}/commits", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#list-gist-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"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},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List gists for a user", - "scope": "gists", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/gists", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists public gists for the specified user:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#list-gists-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List gist forks", - "scope": "gists", - "id": "listForks", - "method": "GET", - "url": "/gists/{gist_id}/forks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#list-gist-forks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":1,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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}}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List public gists", - "scope": "gists", - "id": "listPublic", - "method": "GET", - "url": "/gists/public", - "isDeprecated": false, - "deprecationDate": null, - "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@3.0/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#list-public-gists", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List starred gists", - "scope": "gists", - "id": "listStarred", - "method": "GET", - "url": "/gists/starred", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the authenticated user's starred gists:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#list-starred-gists", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Star a gist", - "scope": "gists", - "id": "star", - "method": "PUT", - "url": "/gists/{gist_id}/star", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#star-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "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 }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unstar a gist", - "scope": "gists", - "id": "unstar", - "method": "DELETE", - "url": "/gists/{gist_id}/star", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#unstar-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "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 }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a gist", - "scope": "gists", - "id": "update", - "method": "PATCH", - "url": "/gists/{gist_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists/#update-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "Description of the gist", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files", - "description": "Names of files to be updated", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*.content", - "description": "The new content of the file", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*.filename", - "description": "The new filename for the file", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a gist comment", - "scope": "gists", - "id": "updateComment", - "method": "PATCH", - "url": "/gists/{gist_id}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gists#update-a-gist-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The comment text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"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},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a blob", - "scope": "git", - "id": "createBlob", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/blobs", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#create-a-blob", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The new blob's content.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "encoding", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a commit", - "scope": "git", - "id": "createCommit", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/commits", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#create-a-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The commit message", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree", - "description": "The SHA of the tree object this commit points to", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parents", - "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author", - "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.email", - "description": "The email of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.date", - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer", - "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.email", - "description": "The email of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.date", - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "signature", - "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132\",\"sha\":\"827efc6d56897b048c772eb4087f854f46256132\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0\",\"sha\":\"7d1b31e74ee336d15cbd21741bc88a537ed063a0\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null},\"html_url\":\"https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a reference", - "scope": "git", - "id": "createRef", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/refs", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#create-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "The SHA1 value for this reference.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a tag object", - "scope": "git", - "id": "createTag", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/tags", - "isDeprecated": false, - "deprecationDate": null, - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.0/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.0/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#create-a-tag-object", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag", - "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The tag message.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "object", - "description": "The SHA of the git object this is tagging.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "type", - "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["commit", "tree", "blob"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger", - "description": "An object with information about the individual creating the tag.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger.name", - "description": "The name of the author of the tag", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger.email", - "description": "The email of the author of the tag", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger.date", - "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"node_id\":\"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\"tag\":\"v0.0.1\",\"sha\":\"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"message\":\"initial version\",\"tagger\":{\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\",\"date\":\"2014-11-07T22:01:45Z\"},\"object\":{\"type\":\"commit\",\"sha\":\"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a tree", - "scope": "git", - "id": "createTree", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/trees", - "isDeprecated": false, - "deprecationDate": null, - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@3.0/rest/reference/git#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-server@3.0/rest/reference/git#update-a-reference).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#create-a-tree", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree", - "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", - "in": "BODY", - "type": "object[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].path", - "description": "The file referenced in the tree.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].mode", - "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["100644", "100755", "040000", "160000", "120000"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].type", - "description": "Either `blob`, `tree`, or `commit`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["blob", "tree", "commit"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].sha", - "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].content", - "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base_tree", - "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"sha\":\"cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\"tree\":[{\"path\":\"file.rb\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":132,\"sha\":\"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"}],\"truncated\":true}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a reference", - "scope": "git", - "id": "deleteRef", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/git/refs/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#delete-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "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 }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a blob", - "scope": "git", - "id": "getBlob", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#get-a-blob", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "file_sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content\":\"Q29udGVudCBvZiB0aGUgYmxvYg==\",\"encoding\":\"base64\",\"url\":\"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"size\":19,\"node_id\":\"Q29udGVudCBvZiB0aGUgYmxvYg==\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a commit", - "scope": "git", - "id": "getCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#get-a-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "commit_sha parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"added readme, because im a good github citizen\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a reference", - "scope": "git", - "id": "getRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/ref/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.0/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#get-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a tag", - "scope": "git", - "id": "getTag", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#get-a-tag", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag_sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"node_id\":\"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\"tag\":\"v0.0.1\",\"sha\":\"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"message\":\"initial version\",\"tagger\":{\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\",\"date\":\"2014-11-07T22:01:45Z\"},\"object\":{\"type\":\"commit\",\"sha\":\"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a tree", - "scope": "git", - "id": "getTree", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#get-a-tree", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree_sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "recursive", - "description": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `\"true\"`, and `\"false\"`. Omit this parameter to prevent recursively returning objects or subtrees.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"sha\":\"9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\"tree\":[{\"path\":\"file.rb\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":30,\"sha\":\"44b4fc6d56897b048c772eb4087f854f46256132\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132\"},{\"path\":\"subdir\",\"mode\":\"040000\",\"type\":\"tree\",\"sha\":\"f484d249c660418515fb01c2b9662073663c242e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e\"},{\"path\":\"exec_file\",\"mode\":\"100755\",\"type\":\"blob\",\"size\":75,\"sha\":\"45b983be36b73c0788dc9cbcb76cbb80fc7bb057\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057\"}],\"truncated\":false}" - }, - { - "data": "{\"sha\":\"fc6274d15fa3ae2ab983129fb037999f264ba9a7\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7\",\"tree\":[{\"path\":\"subdir/file.txt\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":132,\"sha\":\"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"}],\"truncated\":false}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List matching references", - "scope": "git", - "id": "listMatchingRefs", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.0/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#list-matching-references", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"ref\":\"refs/heads/feature-a\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}},{\"ref\":\"refs/heads/feature-b\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b\",\"object\":{\"type\":\"commit\",\"sha\":\"612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\"}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a reference", - "scope": "git", - "id": "updateRef", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/git/refs/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/git#update-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "The SHA1 value to set this reference to", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "force", - "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all gitignore templates", - "scope": "gitignore", - "id": "getAllTemplates", - "method": "GET", - "url": "/gitignore/templates", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-repository-for-the-authenticated-user).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gitignore#get-all-gitignore-templates", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[\"Actionscript\",\"Android\",\"AppceleratorTitanium\",\"Autotools\",\"Bancha\",\"C\",\"C++\"]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a gitignore template", - "scope": "gitignore", - "id": "getTemplate", - "method": "GET", - "url": "/gitignore/templates/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "The API also allows fetching the source of a single template.\nUse the raw [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types/) to get the raw contents.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/gitignore#get-a-gitignore-template", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"C\",\"source\":\"# Object files\\n*.o\\n\\n# Libraries\\n*.lib\\n*.a\\n\\n# Shared objects (inc. Windows DLLs)\\n*.dll\\n*.so\\n*.so.*\\n*.dylib\\n\\n# Executables\\n*.exe\\n*.out\\n*.app\\n\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Add assignees to an issue", - "scope": "issues", - "id": "addAssignees", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "isDeprecated": false, - "deprecationDate": null, - "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#add-assignees-to-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"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}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"author_association\":\"COLLABORATOR\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add labels to an issue", - "scope": "issues", - "id": "addLabels", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#add-labels-to-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels[].name", - "description": "", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Check if a user can be assigned", - "scope": "issues", - "id": "checkUserCanBeAssigned", - "method": "GET", - "url": "/repos/{owner}/{repo}/assignees/{assignee}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#check-if-a-user-can-be-assigned", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.", - "examples": null - }, - { - "code": 404, - "description": "Otherwise a `404` status code is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create an issue", - "scope": "issues", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#create-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the issue.", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the issue.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "in": "BODY", - "type": "undefined[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Create an issue comment", - "scope": "issues", - "id": "createComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#create-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a label", - "scope": "issues", - "id": "createLabel", - "method": "POST", - "url": "/repos/{owner}/{repo}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#create-a-label", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "color", - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the label.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a milestone", - "scope": "issues", - "id": "createMilestone", - "method": "POST", - "url": "/repos/{owner}/{repo}/milestones", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#create-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the milestone.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the milestone. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A description of the milestone.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "due_on", - "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an issue comment", - "scope": "issues", - "id": "deleteComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#delete-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a label", - "scope": "issues", - "id": "deleteLabel", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#delete-a-label", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "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": "Delete a milestone", - "scope": "issues", - "id": "deleteMilestone", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#delete-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone_number", - "description": "milestone_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an issue", - "scope": "issues", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#get-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "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\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an issue comment", - "scope": "issues", - "id": "getComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#get-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an issue event", - "scope": "issues", - "id": "getEvent", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/events/{event_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#get-an-issue-event", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"issue\":{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"performed_via_github_app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"author_association\":\"COLLABORATOR\"}}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a label", - "scope": "issues", - "id": "getLabel", - "method": "GET", - "url": "/repos/{owner}/{repo}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#get-a-label", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a milestone", - "scope": "issues", - "id": "getMilestone", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#get-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone_number", - "description": "milestone_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List issues assigned to the authenticated user", - "scope": "issues", - "id": "list", - "method": "GET", - "url": "/issues", - "isDeprecated": false, - "deprecationDate": 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 v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-issues-assigned-to-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "filter", - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "collab", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "orgs", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owned", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pulls", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List assignees", - "scope": "issues", - "id": "listAssignees", - "method": "GET", - "url": "/repos/{owner}/{repo}/assignees", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-assignees", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List issue comments", - "scope": "issues", - "id": "listComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Issue Comments are ordered by ascending ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-issue-comments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List issue comments for a repository", - "scope": "issues", - "id": "listCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "By default, Issue Comments are ordered by ascending ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-issue-comments-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List issue events", - "scope": "issues", - "id": "listEvents", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-issue-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"performed_via_github_app\":null,\"label\":{\"name\":\"label\",\"color\":\"red\"}}]" - } - ] - }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List issue events for a repository", - "scope": "issues", - "id": "listEventsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-issue-events-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"issue\":{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"author_association\":\"COLLABORATOR\"}}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List timeline events for an issue", - "scope": "issues", - "id": "listEventsForTimeline", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-timeline-events-for-an-issue", - "previews": [{ "name": "mockingbird" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "List user account issues assigned to the authenticated user", - "scope": "issues", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "filter", - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List organization issues assigned to the authenticated user", - "scope": "issues", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all` or `repos`: All issues the authenticated user can see, regardless of participation or creation", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository issues", - "scope": "issues", - "id": "listForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-repository-issues", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone", - "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "creator", - "description": "The user that created the issue.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "mentioned", - "description": "A user that's mentioned in the issue.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List labels for issues in a milestone", - "scope": "issues", - "id": "listLabelsForMilestone", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-labels-for-issues-in-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone_number", - "description": "milestone_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List labels for a repository", - "scope": "issues", - "id": "listLabelsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-labels-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List labels for an issue", - "scope": "issues", - "id": "listLabelsOnIssue", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-labels-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List milestones", - "scope": "issues", - "id": "listMilestones", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#list-milestones", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the milestone. Either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by. Either `due_on` or `completeness`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["due_on", "completeness"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction of the sort. Either `asc` or `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Lock an issue", - "scope": "issues", - "id": "lock", - "method": "PUT", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#lock-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "lock_reason", - "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["off-topic", "too heated", "resolved", "spam"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove all labels from an issue", - "scope": "issues", - "id": "removeAllLabels", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#remove-all-labels-from-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "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": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove assignees from an issue", - "scope": "issues", - "id": "removeAssignees", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes one or more assignees from an issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#remove-assignees-from-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "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\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"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}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"author_association\":\"COLLABORATOR\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove a label from an issue", - "scope": "issues", - "id": "removeLabel", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#remove-a-label-from-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Set labels for an issue", - "scope": "issues", - "id": "setLabels", - "method": "PUT", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes any previous labels and sets the new labels for an issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#set-labels-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels[].name", - "description": "", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Unlock an issue", - "scope": "issues", - "id": "unlock", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access can unlock an issue's conversation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#unlock-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an issue", - "scope": "issues", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/issues/{issue_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Issue owners and users with push access can edit an issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues/#update-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the issue.", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the issue.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "State of the issue. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", - "in": "BODY", - "type": "undefined[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "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\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an issue comment", - "scope": "issues", - "id": "updateComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#update-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a label", - "scope": "issues", - "id": "updateLabel", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#update-a-label", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "new_name", - "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "color", - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the label.", - "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\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:\",\"name\":\"bug :bug:\",\"description\":\"Small bug fix required\",\"color\":\"b01f26\",\"default\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a milestone", - "scope": "issues", - "id": "updateMilestone", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/issues#update-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone_number", - "description": "milestone_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the milestone.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the milestone. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A description of the milestone.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "due_on", - "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a license", - "scope": "licenses", - "id": "get", - "method": "GET", - "url": "/licenses/{license}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/licenses#get-a-license", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "license", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"http://choosealicense.com/licenses/mit/\",\"description\":\"A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.\",\"implementation\":\"Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.\",\"permissions\":[\"commercial-use\",\"modifications\",\"distribution\",\"sublicense\",\"private-use\"],\"conditions\":[\"include-copyright\"],\"limitations\":[\"no-liability\"],\"body\":\"\\n\\nThe MIT License (MIT)\\n\\nCopyright (c) [year] [fullname]\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in all\\ncopies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\\nSOFTWARE.\\n\",\"featured\":true}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all commonly used licenses", - "scope": "licenses", - "id": "getAllCommonlyUsed", - "method": "GET", - "url": "/licenses", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/licenses#get-all-commonly-used-licenses", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "featured", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"lgpl-3.0\",\"name\":\"GNU Lesser General Public License v3.0\",\"spdx_id\":\"LGPL-3.0\",\"url\":\"https://api.github.com/licenses/lgpl-3.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"mpl-2.0\",\"name\":\"Mozilla Public License 2.0\",\"spdx_id\":\"MPL-2.0\",\"url\":\"https://api.github.com/licenses/mpl-2.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"agpl-3.0\",\"name\":\"GNU Affero General Public License v3.0\",\"spdx_id\":\"AGPL-3.0\",\"url\":\"https://api.github.com/licenses/agpl-3.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"unlicense\",\"name\":\"The Unlicense\",\"spdx_id\":\"Unlicense\",\"url\":\"https://api.github.com/licenses/unlicense\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"apache-2.0\",\"name\":\"Apache License 2.0\",\"spdx_id\":\"Apache-2.0\",\"url\":\"https://api.github.com/licenses/apache-2.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"gpl-3.0\",\"name\":\"GNU General Public License v3.0\",\"spdx_id\":\"GPL-3.0\",\"url\":\"https://api.github.com/licenses/gpl-3.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the license for a repository", - "scope": "licenses", - "id": "getForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/license", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/licenses/#get-the-license-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"LICENSE\",\"path\":\"LICENSE\",\"sha\":\"401c59dcc4570b954dd6d345e76199e1f4e76266\",\"size\":1077,\"url\":\"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\"html_url\":\"https://github.com/benbalter/gman/blob/master/LICENSE\",\"git_url\":\"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\"download_url\":\"https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true\",\"type\":\"file\",\"content\":\"VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\\n\",\"encoding\":\"base64\",\"_links\":{\"self\":\"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\"git\":\"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\"html\":\"https://github.com/benbalter/gman/blob/master/LICENSE\"},\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Render a Markdown document", - "scope": "markdown", - "id": "render", - "method": "POST", - "url": "/markdown", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/markdown#render-a-markdown-document", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "text", - "description": "The Markdown text to render in HTML.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "mode", - "description": "The rendering mode.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["markdown", "gfm"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "context", - "description": "The repository context to use when creating references in `gfm` mode.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Render a Markdown document in raw mode", - "scope": "markdown", - "id": "renderRaw", - "method": "POST", - "url": "/markdown/raw", - "isDeprecated": false, - "deprecationDate": null, - "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/markdown#render-a-markdown-document-in-raw-mode", - "previews": [], - "headers": [ - { "name": "content-type", "value": "text/plain; charset=utf-8" } - ], - "parameters": [ - { - "name": "data", - "description": "raw markdown text", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get GitHub Enterprise Server meta information", - "scope": "meta", - "id": "get", - "method": "GET", - "url": "/meta", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/meta#get-github-meta-information", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"verifiable_password_authentication\":true,\"packages\":[\"192.30.252.0/22\"],\"dependabot\":[\"54.158.161.132\"],\"installed_version\":\"3.0.0\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get Octocat", - "scope": "meta", - "id": "getOctocat", - "method": "GET", - "url": "/octocat", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get the octocat as ASCII art", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/meta#get-octocat", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "s", - "description": "The words to show in Octocat's speech bubble", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get the Zen of GitHub", - "scope": "meta", - "id": "getZen", - "method": "GET", - "url": "/zen", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get a random sentence from the Zen of GitHub", - "documentationUrl": "", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "GitHub API Root", - "scope": "meta", - "id": "root", - "method": "GET", - "url": "/", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get Hypermedia links to resources accessible in GitHub's REST API", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#root-endpoint", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Check organization membership for a user", - "scope": "orgs", - "id": "checkMembershipForUser", - "method": "GET", - "url": "/orgs/{org}/members/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Check if a user is, publicly or privately, a member of the organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#check-organization-membership-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if requester is an organization member and user is a member", - "examples": null - }, - { - "code": 302, - "description": "Response if requester is not an organization member", - "examples": null - }, - { - "code": 404, - "description": "Not Found if requester is an organization member and user is not a member", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check public organization membership for a user", - "scope": "orgs", - "id": "checkPublicMembershipForUser", - "method": "GET", - "url": "/orgs/{org}/public_members/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#check-public-organization-membership-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if user is a public member", - "examples": null - }, - { - "code": 404, - "description": "Not Found if user is not a public member", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Convert an organization member to outside collaborator", - "scope": "orgs", - "id": "convertMemberToOutsideCollaborator", - "method": "PUT", - "url": "/orgs/{org}/outside_collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "User is getting converted asynchronously", - "examples": null - }, - { "code": 204, "description": "User was converted", "examples": null }, - { - "code": 403, - "description": "Forbidden if user is the last owner of the organization or not a member of the organization", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create an organization webhook", - "scope": "orgs", - "id": "createWebhook", - "method": "POST", - "url": "/orgs/{org}/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Here's how you can create a hook that posts payloads in JSON format:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#create-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Must be passed as \"web\".", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#create-hook-config-params).", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.username", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.password", - "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/enterprise-server@3.0/webhooks/event-payloads) the hook is triggered for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an organization webhook", - "scope": "orgs", - "id": "deleteWebhook", - "method": "DELETE", - "url": "/orgs/{org}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#delete-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an organization", - "scope": "orgs", - "id": "get", - "method": "GET", - "url": "/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub Enterprise Server plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#get-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an organization membership for the authenticated user", - "scope": "orgs", - "id": "getMembershipForAuthenticatedUser", - "method": "GET", - "url": "/user/memberships/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"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": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get organization membership for a user", - "scope": "orgs", - "id": "getMembershipForUser", - "method": "GET", - "url": "/orgs/{org}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#get-organization-membership-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an organization webhook", - "scope": "orgs", - "id": "getWebhook", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#get-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a webhook configuration for an organization", - "scope": "orgs", - "id": "getWebhookConfigForOrg", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}/config", - "isDeprecated": false, - "deprecationDate": 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/reference/orgs#get-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#get-a-webhook-configuration-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organizations", - "scope": "orgs", - "id": "list", - "method": "GET", - "url": "/organizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#list-organizations", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "An organization ID. Only return organizations with an ID greater than this ID.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "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\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "List app installations for an organization", - "scope": "orgs", - "id": "listAppInstallations", - "method": "GET", - "url": "/orgs/{org}/installations", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#list-app-installations-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"installations\":[{\"id\":25381,\"account\":{\"login\":\"octo-org\",\"id\":6811672,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=\",\"avatar_url\":\"https://avatars3.githubusercontent.com/u/6811672?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"selected\",\"access_tokens_url\":\"https://api.github.com/app/installations/25381/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/octo-org/settings/installations/25381\",\"app_id\":2218,\"target_id\":6811672,\"target_type\":\"Organization\",\"permissions\":{\"deployments\":\"write\",\"metadata\":\"read\",\"pull_requests\":\"read\",\"statuses\":\"read\"},\"events\":[\"deployment\",\"deployment_status\"],\"created_at\":\"2017-05-16T08:47:09.000-07:00\",\"updated_at\":\"2017-06-06T11:23:23.000-07:00\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organizations for the authenticated user", - "scope": "orgs", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/orgs", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#list-organizations-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "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\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List organizations for a user", - "scope": "orgs", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/orgs", - "isDeprecated": false, - "deprecationDate": null, - "description": "List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#list-organizations-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organization members", - "scope": "orgs", - "id": "listMembers", - "method": "GET", - "url": "/orgs/{org}/members", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#list-organization-members", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["2fa_disabled", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "admin", "member"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { - "code": 302, - "description": "Response if requester is not an organization member", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List organization memberships for the authenticated user", - "scope": "orgs", - "id": "listMembershipsForAuthenticatedUser", - "method": "GET", - "url": "/user/memberships/orgs", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "state", - "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["active", "pending"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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}},{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"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": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List outside collaborators for an organization", - "scope": "orgs", - "id": "listOutsideCollaborators", - "method": "GET", - "url": "/orgs/{org}/outside_collaborators", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all users who are outside collaborators of an organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#list-outside-collaborators-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["2fa_disabled", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public organization members", - "scope": "orgs", - "id": "listPublicMembers", - "method": "GET", - "url": "/orgs/{org}/public_members", - "isDeprecated": false, - "deprecationDate": null, - "description": "Members of an organization can choose to have their membership publicized or not.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#list-public-organization-members", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organization webhooks", - "scope": "orgs", - "id": "listWebhooks", - "method": "GET", - "url": "/orgs/{org}/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#list-organization-webhooks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Ping an organization webhook", - "scope": "orgs", - "id": "pingWebhook", - "method": "POST", - "url": "/orgs/{org}/hooks/{hook_id}/pings", - "isDeprecated": false, - "deprecationDate": null, - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.0/webhooks/#ping-event) to be sent to the hook.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#ping-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove an organization member", - "scope": "orgs", - "id": "removeMember", - "method": "DELETE", - "url": "/orgs/{org}/members/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#remove-an-organization-member", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "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 }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove organization membership for a user", - "scope": "orgs", - "id": "removeMembershipForUser", - "method": "DELETE", - "url": "/orgs/{org}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#remove-organization-membership-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "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 }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove outside collaborator from an organization", - "scope": "orgs", - "id": "removeOutsideCollaborator", - "method": "DELETE", - "url": "/orgs/{org}/outside_collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removing a user from this list will remove them from all the organization's repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#remove-outside-collaborator-from-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "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 }, - { - "code": 422, - "description": "Unprocessable Entity if user is a member of the organization", - "examples": [ - { - "data": "{\"message\":\"You cannot specify an organization member to remove as an outside collaborator.\",\"documentation_url\":\"https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#remove-outside-collaborator\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove public organization membership for the authenticated user", - "scope": "orgs", - "id": "removePublicMembershipForAuthenticatedUser", - "method": "DELETE", - "url": "/orgs/{org}/public_members/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "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": "Set organization membership for a user", - "scope": "orgs", - "id": "setMembershipForUser", - "method": "PUT", - "url": "/orgs/{org}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/reference/orgs#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/enterprise-server@3.0/rest/reference/orgs#set-organization-membership-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "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", "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, - "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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "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 }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an organization", - "scope": "orgs", - "id": "update", - "method": "PATCH", - "url": "/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs/#update-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "billing_email", - "description": "Billing email address. This address is not publicized.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "company", - "description": "The company name.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "email", - "description": "The publicly visible email address.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "twitter_username", - "description": "The Twitter username of the company.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "location", - "description": "The location.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The shorthand name of the company.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the company.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_organization_projects", - "description": "Toggles whether an organization can use organization projects.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_repository_projects", - "description": "Toggles whether repositories that belong to the organization can use repository projects.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "default_repository_permission", - "description": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin", "none"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_repositories", - "description": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_internal_repositories", - "description": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_private_repositories", - "description": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_public_repositories", - "description": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_allowed_repository_creation_type", - "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "private", "none"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_pages", - "description": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "blog", - "description": "", - "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": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an organization membership for the authenticated user", - "scope": "orgs", - "id": "updateMembershipForAuthenticatedUser", - "method": "PATCH", - "url": "/user/memberships/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["active"], - "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": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an organization webhook", - "scope": "orgs", - "id": "updateWebhook", - "method": "PATCH", - "url": "/orgs/{org}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#update-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#update-hook-config-params).", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "events", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads) the hook is triggered for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "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\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a webhook configuration for an organization", - "scope": "orgs", - "id": "updateWebhookConfigForOrg", - "method": "PATCH", - "url": "/orgs/{org}/hooks/{hook_id}/config", - "isDeprecated": false, - "deprecationDate": 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/reference/orgs#update-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/orgs#update-a-webhook-configuration-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add project collaborator", - "scope": "projects", - "id": "addCollaborator", - "method": "PUT", - "url": "/projects/{project_id}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#add-project-collaborator", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "The permission to grant the collaborator.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a project card", - "scope": "projects", - "id": "createCard", - "method": "POST", - "url": "/projects/columns/{column_id}/cards", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#create-a-project-card", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "column_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "note", - "description": "The project card's note", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_id", - "description": "The unique identifier of the content associated with the card", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_type", - "description": "The piece of content associated with the card", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 503, "description": "Response", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a project column", - "scope": "projects", - "id": "createColumn", - "method": "POST", - "url": "/projects/{project_id}/columns", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#create-a-project-column", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Name of the project column", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a user project", - "scope": "projects", - "id": "createForAuthenticatedUser", - "method": "POST", - "url": "/user/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#create-a-user-project", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "Name of the project", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "Body of the project", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/users/octocat\",\"url\":\"https://api.github.com/projects/1002603\",\"html_url\":\"https://github.com/users/octocat/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002603/columns\",\"id\":1002603,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDM=\",\"name\":\"My Projects\",\"body\":\"A board to manage my personal projects.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create an organization project", - "scope": "projects", - "id": "createForOrg", - "method": "POST", - "url": "/orgs/{org}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#create-an-organization-project", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the project.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The description of the project.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a repository project", - "scope": "projects", - "id": "createForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#create-a-repository-project", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the project.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The description of the project.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a project", - "scope": "projects", - "id": "delete", - "method": "DELETE", - "url": "/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#delete-a-project", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Delete Success", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a project card", - "scope": "projects", - "id": "deleteCard", - "method": "DELETE", - "url": "/projects/columns/cards/{card_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#delete-a-project-card", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "card_id", - "description": "card_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a project column", - "scope": "projects", - "id": "deleteColumn", - "method": "DELETE", - "url": "/projects/columns/{column_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#delete-a-project-column", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "column_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a project", - "scope": "projects", - "id": "get", - "method": "GET", - "url": "/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#get-a-project", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a project card", - "scope": "projects", - "id": "getCard", - "method": "GET", - "url": "/projects/columns/cards/{card_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#get-a-project-card", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "card_id", - "description": "card_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a project column", - "scope": "projects", - "id": "getColumn", - "method": "GET", - "url": "/projects/columns/{column_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#get-a-project-column", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "column_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get project permission for a user", - "scope": "projects", - "id": "getPermissionForUser", - "method": "GET", - "url": "/projects/{project_id}/collaborators/{username}/permission", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#get-project-permission-for-a-user", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List project cards", - "scope": "projects", - "id": "listCards", - "method": "GET", - "url": "/projects/columns/{column_id}/cards", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#list-project-cards", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "column_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "archived", "not_archived"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List project collaborators", - "scope": "projects", - "id": "listCollaborators", - "method": "GET", - "url": "/projects/{project_id}/collaborators", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the collaborators for an organization project. For a project, 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. You must be an organization owner or a project `admin` to list collaborators.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#list-project-collaborators", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["outside", "direct", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List project columns", - "scope": "projects", - "id": "listColumns", - "method": "GET", - "url": "/projects/{project_id}/columns", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#list-project-columns", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List organization projects", - "scope": "projects", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#list-organization-projects", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository projects", - "scope": "projects", - "id": "listForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#list-repository-projects", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}]" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List user projects", - "scope": "projects", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#list-user-projects", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/users/octocat\",\"url\":\"https://api.github.com/projects/1002603\",\"html_url\":\"https://github.com/users/octocat/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002603/columns\",\"id\":1002603,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDM=\",\"name\":\"My Projects\",\"body\":\"A board to manage my personal projects.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}]" - } - ] - }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Move a project card", - "scope": "projects", - "id": "moveCard", - "method": "POST", - "url": "/projects/columns/cards/{card_id}/moves", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#move-a-project-card", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "card_id", - "description": "card_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:top|bottom|after:\\d+)$", - "alias": null, - "deprecated": null - }, - { - "name": "column_id", - "description": "The unique identifier of the column the card should be moved to", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 201, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 503, "description": "Response", "examples": null } - ], - "renamed": null - }, - { - "name": "Move a project column", - "scope": "projects", - "id": "moveColumn", - "method": "POST", - "url": "/projects/columns/{column_id}/moves", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#move-a-project-column", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "column_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:first|last|after:\\d+)$", - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 201, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove user as a collaborator", - "scope": "projects", - "id": "removeCollaborator", - "method": "DELETE", - "url": "/projects/{project_id}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#remove-project-collaborator", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "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 }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a project", - "scope": "projects", - "id": "update", - "method": "PATCH", - "url": "/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#update-a-project", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Name of the project", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "Body of the project", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "State of the project; either 'open' or 'closed'", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "organization_permission", - "description": "The baseline permission that all organization members have on this project", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin", "none"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Whether or not this project can be seen by everyone.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if the authenticated user does not have access to the project", - "examples": null - }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an existing project card", - "scope": "projects", - "id": "updateCard", - "method": "PATCH", - "url": "/projects/columns/cards/{card_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#update-a-project-card", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "card_id", - "description": "card_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "note", - "description": "The project card's note", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "archived", - "description": "Whether or not the card is archived", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an existing project column", - "scope": "projects", - "id": "updateColumn", - "method": "PATCH", - "url": "/projects/columns/{column_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/projects#update-a-project-column", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "column_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Name of the project column", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Check if a pull request has been merged", - "scope": "pulls", - "id": "checkIfMerged", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#check-if-a-pull-request-has-been-merged", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if pull request has been merged", - "examples": null - }, - { - "code": 404, - "description": "Not Found if pull request has not been merged", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a pull request", - "scope": "pulls", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls", - "isDeprecated": false, - "deprecationDate": null, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#create-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the new pull request.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the pull request.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "draft", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue", - "description": "", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a reply for a review comment", - "scope": "pulls", - "id": "createReplyForReviewComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "isDeprecated": false, - "deprecationDate": 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#create-a-reply-for-a-review-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The text of the review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":426899381,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a review for a pull request", - "scope": "pulls", - "id": "createReview", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response.\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 v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.0/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/enterprise-server@3.0/rest/reference/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#create-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_id", - "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments", - "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].path", - "description": "The relative path to the file that necessitates a review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "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.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].body", - "description": "Text of the review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].line", - "description": "", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].side", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].start_line", - "description": "", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].start_side", - "description": "", - "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\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change.\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a review comment for a pull request", - "scope": "pulls", - "id": "createReviewComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#create-a-review-comment-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The text of the review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_id", - "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "The relative path to the file that necessitates a comment.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "side", - "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["LEFT", "RIGHT"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "line", - "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "start_line", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "start_side", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["LEFT", "RIGHT", "side"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "in_reply_to", - "description": "", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a pending review for a pull request", - "scope": "pulls", - "id": "deletePendingReview", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#delete-a-pending-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "review_id parameter", - "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\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change.\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a review comment for a pull request", - "scope": "pulls", - "id": "deleteReviewComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a review comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#delete-a-review-comment-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Dismiss a review for a pull request", - "scope": "pulls", - "id": "dismissReview", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#dismiss-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "review_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The message for the pull request review dismissal", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "", - "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\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"state\":\"DISMISSED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a pull request", - "scope": "pulls", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server 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/enterprise-server@3.0/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 Enterprise Server has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#get-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a review for a pull request", - "scope": "pulls", - "id": "getReview", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#get-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "review_id parameter", - "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\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a review comment for a pull request", - "scope": "pulls", - "id": "getReviewComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Provides details for a review comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#get-a-review-comment-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List pull requests", - "scope": "pulls", - "id": "list", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls", - "isDeprecated": false, - "deprecationDate": null, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-pull-requests", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Either `open`, `closed`, or `all` to filter by state.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "Filter pulls by base branch name. Example: `gh-pages`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "popularity", "long-running"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List comments for a pull request review", - "scope": "pulls", - "id": "listCommentsForReview", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "List comments for a specific pull request review.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-comments-for-a-pull-request-review", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "review_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List commits on a pull request", - "scope": "pulls", - "id": "listCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/reference/repos#list-commits) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-commits-on-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pull requests files", - "scope": "pulls", - "id": "listFiles", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-pull-requests-files", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "List requested reviewers for a pull request", - "scope": "pulls", - "id": "listRequestedReviewers", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-requested-reviewers-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List review comments on a pull request", - "scope": "pulls", - "id": "listReviewComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-review-comments-on-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List review comments in a repository", - "scope": "pulls", - "id": "listReviewCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-review-comments-in-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "created_at"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reviews for a pull request", - "scope": "pulls", - "id": "listReviews", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "The list of reviews returns in chronological order.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-reviews-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The list of reviews returns in chronological order.", - "examples": [ - { - "data": "[{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Merge a pull request", - "scope": "pulls", - "id": "merge", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.0/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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#merge-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_title", - "description": "Title for the automatic commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_message", - "description": "Extra detail to append to automatic commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "SHA that pull request head must match to allow merge.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_method", - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["merge", "squash", "rebase"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if merge was successful", - "examples": [ - { - "data": "{\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"merged\":true,\"message\":\"Pull Request successfully merged\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 405, - "description": "Method Not Allowed if merge cannot be performed", - "examples": [ - { "data": "{\"message\":\"Pull Request is not mergeable\"}" } - ] - }, - { - "code": 409, - "description": "Conflict if sha was provided and pull request head did not match", - "examples": [ - { - "data": "{\"message\":\"Head branch was modified. Review and try the merge again.\"}" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove requested reviewers from a pull request", - "scope": "pulls", - "id": "removeRequestedReviewers", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reviewers", - "description": "An array of user `login`s that will be removed.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_reviewers", - "description": "An array of team `slug`s that will be removed.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Request reviewers for a pull request", - "scope": "pulls", - "id": "requestReviewers", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.0/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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#request-reviewers-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reviewers", - "description": "An array of user `login`s that will be requested.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_reviewers", - "description": "An array of team `slug`s that will be requested.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"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,\"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}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Unprocessable Entity if user is not a collaborator", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Submit a review for a pull request", - "scope": "pulls", - "id": "submitReview", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#submit-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "review_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body text of the pull request review", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a pull request", - "scope": "pulls", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls/#update-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the pull request.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the pull request.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "State of this Pull Request. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a pull request branch", - "scope": "pulls", - "id": "updateBranch", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#update-a-pull-request-branch", - "previews": [{ "name": "lydian" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "expected_head_sha", - "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"message\":\"Updating pull request branch.\",\"url\":\"https://github.com/repos/octocat/Hello-World/pulls/53\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a review for a pull request", - "scope": "pulls", - "id": "updateReview", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Update the review summary comment with new text.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#update-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "review_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body text of the pull request review.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change. And add more about this.\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a review comment for a pull request", - "scope": "pulls", - "id": "updateReviewComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables you to edit a review comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#update-a-review-comment-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The text of the reply to the review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get rate limit status for the authenticated user", - "scope": "rateLimit", - "id": "get", - "method": "GET", - "url": "/rate_limit", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\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/enterprise-server@3.0/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"resources\":{\"core\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873,\"used\":1},\"search\":{\"limit\":30,\"remaining\":18,\"reset\":1372697452,\"used\":12},\"graphql\":{\"limit\":5000,\"remaining\":4993,\"reset\":1372700389,\"used\":7},\"integration_manifest\":{\"limit\":5000,\"remaining\":4999,\"reset\":1551806725,\"used\":1},\"code_scanning_upload\":{\"limit\":500,\"remaining\":499,\"reset\":1551806725,\"used\":1}},\"rate\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873,\"used\":1}}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create reaction for a commit comment", - "scope": "reactions", - "id": "createForCommitComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#create-reaction-for-a-commit-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types) to add to the commit comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Reaction exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Reaction created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create reaction for an issue", - "scope": "reactions", - "id": "createForIssue", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.0/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#create-reaction-for-an-issue", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types) to add to the issue.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create reaction for an issue comment", - "scope": "reactions", - "id": "createForIssueComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.0/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#create-reaction-for-an-issue-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types) to add to the issue comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Reaction exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Reaction created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create reaction for a pull request review comment", - "scope": "reactions", - "id": "createForPullRequestReviewComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types) to add to the pull request review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Reaction exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Reaction created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create reaction for a team discussion comment", - "scope": "reactions", - "id": "createForTeamDiscussionCommentInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#create-reaction-for-a-team-discussion-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create reaction for a team discussion comment (Legacy)", - "scope": "reactions", - "id": "createForTeamDiscussionCommentLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "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/enterprise-server@3.0/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment-legacy", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create reaction for a team discussion", - "scope": "reactions", - "id": "createForTeamDiscussionInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#create-reaction-for-a-team-discussion", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types) to add to the team discussion.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create reaction for a team discussion (Legacy)", - "scope": "reactions", - "id": "createForTeamDiscussionLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "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/enterprise-server@3.0/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions/#create-reaction-for-a-team-discussion-legacy", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types) to add to the team discussion.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a commit comment reaction", - "scope": "reactions", - "id": "deleteForCommitComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#delete-a-commit-comment-reaction", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an issue reaction", - "scope": "reactions", - "id": "deleteForIssue", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-server@3.0/rest/reference/issues/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#delete-an-issue-reaction", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an issue comment reaction", - "scope": "reactions", - "id": "deleteForIssueComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.0/rest/reference/issues#comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#delete-an-issue-comment-reaction", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "", - "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 a pull request comment reaction", - "scope": "reactions", - "id": "deleteForPullRequestComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#review-comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#delete-a-pull-request-comment-reaction", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "", - "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 team discussion reaction", - "scope": "reactions", - "id": "deleteForTeamDiscussion", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#delete-team-discussion-reaction", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "", - "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 team discussion comment reaction", - "scope": "reactions", - "id": "deleteForTeamDiscussionComment", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#delete-team-discussion-comment-reaction", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "", - "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 a reaction (Legacy)", - "scope": "reactions", - "id": "deleteLegacy", - "method": "DELETE", - "url": "/reactions/{reaction_id}", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#discussion-comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions/#delete-a-reaction-legacy", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "reaction_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for a commit comment", - "scope": "reactions", - "id": "listForCommitComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#list-reactions-for-a-commit-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for an issue", - "scope": "reactions", - "id": "listForIssue", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to an [issue](https://docs.github.com/enterprise-server@3.0/rest/reference/issues).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#list-reactions-for-an-issue", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for an issue comment", - "scope": "reactions", - "id": "listForIssueComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.0/rest/reference/issues#comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#list-reactions-for-an-issue-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for a pull request review comment", - "scope": "reactions", - "id": "listForPullRequestReviewComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#review-comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion comment", - "scope": "reactions", - "id": "listForTeamDiscussionCommentInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#list-reactions-for-a-team-discussion-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion comment (Legacy)", - "scope": "reactions", - "id": "listForTeamDiscussionCommentLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "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/enterprise-server@3.0/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment-legacy", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion", - "scope": "reactions", - "id": "listForTeamDiscussionInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#list-reactions-for-a-team-discussion", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion (Legacy)", - "scope": "reactions", - "id": "listForTeamDiscussionLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "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/enterprise-server@3.0/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/reactions/#list-reactions-for-a-team-discussion-legacy", - "previews": [{ "name": "squirrel-girl" }], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.0/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Accept a repository invitation", - "scope": "repos", - "id": "acceptInvitation", - "method": "PATCH", - "url": "/user/repository_invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#accept-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "invitation_id", - "description": "invitation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null } - ], - "renamed": null - }, - { - "name": "Add app access restrictions", - "scope": "repos", - "id": "addAppAccessRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#add-app-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "apps", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Add a repository collaborator", - "scope": "repos", - "id": "addCollaborator", - "method": "PUT", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#invitations).\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#add-a-repository-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin", "maintain", "triage"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response when a new invitation is created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}" - } - ] - }, - { - "code": 204, - "description": "Response when person is already a collaborator", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Add status check contexts", - "scope": "repos", - "id": "addStatusCheckContexts", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#add-status-check-contexts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[\"continuous-integration/travis-ci\",\"continuous-integration/jenkins\"]" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Add team access restrictions", - "scope": "repos", - "id": "addTeamAccessRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#add-team-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "teams", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Add user access restrictions", - "scope": "repos", - "id": "addUserAccessRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#add-user-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "users", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Check if a user is a repository collaborator", - "scope": "repos", - "id": "checkCollaborator", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#check-if-a-user-is-a-repository-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if user is a collaborator", - "examples": null - }, - { - "code": 404, - "description": "Not Found if user is not a collaborator", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Compare two commits", - "scope": "repos", - "id": "compareCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/compare/{base}...{head}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. 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 response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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\n**Working with large comparisons**\n\nTo process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"[Traversing with pagination](/rest/guides/traversing-with-pagination).\"\n\nWhen calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/rest/reference/repos#compare-two-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/compare/master...topic\",\"html_url\":\"https://github.com/octocat/Hello-World/compare/master...topic\",\"permalink_url\":\"https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17\",\"diff_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.patch\",\"base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"merge_base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"status\":\"behind\",\"ahead_by\":1,\"behind_by\":2,\"total_commits\":1,\"commits\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}],\"files\":[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "Compare two commits", - "scope": "repos", - "id": "compareCommitsWithBasehead", - "method": "GET", - "url": "/repos/{owner}/{repo}/compare/{basehead}", - "isDeprecated": false, - "deprecationDate": null, - "description": "The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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\n**Working with large comparisons**\n\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [List commits](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-commits) to enumerate all commits in the range.\n\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long\nto generate. You can typically resolve this error by using a smaller commit range.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#compare-two-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "basehead", - "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/compare/master...topic\",\"html_url\":\"https://github.com/octocat/Hello-World/compare/master...topic\",\"permalink_url\":\"https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17\",\"diff_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.patch\",\"base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"merge_base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"status\":\"behind\",\"ahead_by\":1,\"behind_by\":2,\"total_commits\":1,\"commits\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}],\"files\":[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a commit comment", - "scope": "repos", - "id": "createCommitComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "commit_sha parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "Relative path of the file to comment on.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "Line index in the diff to comment on.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "line", - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author_association\":\"COLLABORATOR\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create commit signature protection", - "scope": "repos", - "id": "createCommitSignatureProtection", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-commit-signature-protection", - "previews": [{ "name": "zzzax" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\"enabled\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a commit status", - "scope": "repos", - "id": "createCommitStatus", - "method": "POST", - "url": "/repos/{owner}/{repo}/statuses/{sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-commit-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["error", "failure", "pending", "success"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_url", - "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the status.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "context", - "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a deploy key", - "scope": "repos", - "id": "createDeployKey", - "method": "POST", - "url": "/repos/{owner}/{repo}/keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can create a read-only deploy key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-deploy-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "A name for the key.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key", - "description": "The contents of the key.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "read_only", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/).\"", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a deployment", - "scope": "repos", - "id": "createDeployment", - "method": "POST", - "url": "/repos/{owner}/{repo}/deployments", - "isDeprecated": false, - "deprecationDate": 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 Enterprise Server 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/enterprise-server@3.0/rest/reference/repos#statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-deployment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The ref to deploy. This can be a branch, tag, or SHA.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "task", - "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_merge", - "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_contexts", - "description": "The [status](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "payload", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "Short description of the deployment.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "transient_environment", - "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments) custom media type.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "production_environment", - "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments) custom media type.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}" - } - ] - }, - { - "code": 202, - "description": "Merged branch response", - "examples": [ - { - "data": "{\"message\":\"Auto-merged master into topic-branch on deployment.\"}" - } - ] - }, - { - "code": 409, - "description": "Conflict when there is a merge conflict or the commit's status checks failed", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a deployment status", - "scope": "repos", - "id": "createDeploymentStatus", - "method": "POST", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-deployment-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#deployment-statuses) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "error", - "failure", - "inactive", - "in_progress", - "queued", - "pending", - "success" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_url", - "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "log_url", - "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments) custom media type.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the status. The maximum description length is 140 characters.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#deployment-statuses) custom media type.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["production", "staging", "qa"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_url", - "description": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments) custom media type.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_inactive", - "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.0/rest/overview/api-previews#enhanced-deployments) custom media type.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"https://test-branch.lab.acme.com\",\"log_url\":\"https://example.com/deployment/42/output\"}" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a repository dispatch event", - "scope": "repos", - "id": "createDispatchEvent", - "method": "POST", - "url": "/repos/{owner}/{repo}/dispatches", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server 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/enterprise-server@3.0/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis endpoint requires write access to the repository by providing either:\n\n - Personal access tokens with `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-repository-dispatch-event", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event_type", - "description": "A custom webhook event name.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "client_payload", - "description": "JSON payload with extra information about the webhook event that your action or worklow may use.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "client_payload.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a repository for the authenticated user", - "scope": "repos", - "id": "createForAuthenticatedUser", - "method": "POST", - "url": "/user/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-repository-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "The name of the repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "homepage", - "description": "A URL with more information about the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Whether the repository is private.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_issues", - "description": "Whether issues are enabled.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_projects", - "description": "Whether projects are enabled.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_wiki", - "description": "Whether the wiki is enabled.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_id", - "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_init", - "description": "Whether the repository is initialized with a minimal README.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "gitignore_template", - "description": "The desired language or platform to apply to the .gitignore.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "license_template", - "description": "The license keyword of the open source license for this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_squash_merge", - "description": "Whether to allow squash merges for pull requests.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_merge_commit", - "description": "Whether to allow merge commits for pull requests.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_rebase_merge", - "description": "Whether to allow rebase merges for pull requests.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delete_branch_on_merge", - "description": "Whether to delete head branches when pull requests are merged", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_downloads", - "description": "Whether downloads are enabled.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "is_template", - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "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\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a fork", - "scope": "repos", - "id": "createFork", - "method": "POST", - "url": "/repos/{owner}/{repo}/forks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=rest-api).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-fork", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "organization", - "description": "Optional parameter to specify the organization name if forking into an organization.", - "in": "BODY", - "type": "string", - "required": false, - "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\"},\"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\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"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\",\"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,\"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,\"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", "examples": null } - ], - "renamed": null - }, - { - "name": "Create an organization repository", - "scope": "repos", - "id": "createInOrg", - "method": "POST", - "url": "/orgs/{org}/repos", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/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", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-an-organization-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "homepage", - "description": "A URL with more information about the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Whether the repository is private.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["public", "private", "visibility", "internal"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_issues", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_projects", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_wiki", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "is_template", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_id", - "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_init", - "description": "Pass `true` to create an initial commit with empty README.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "gitignore_template", - "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "license_template", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_squash_merge", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_merge_commit", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_rebase_merge", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delete_branch_on_merge", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "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\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create or update file contents", - "scope": "repos", - "id": "createOrUpdateFileContents", - "method": "PUT", - "url": "/repos/{owner}/{repo}/contents/{path}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new file or replaces an existing file in a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-or-update-file-contents", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "path parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The commit message.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The new file content, using Base64 encoding.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer", - "description": "The person that committed the file. Default: the authenticated user.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.name", - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.email", - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.date", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author", - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.name", - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.email", - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.date", - "description": "", - "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": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"a56507ed892d05a37c6d6128c260937ea4d287bd\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"node_id\":\"MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\",\"sha\":\"9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6\",\"sha\":\"da5a433788da5c255edad7979b328b67d79f53f6\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a GitHub Enterprise Server Pages site", - "scope": "repos", - "id": "createPagesSite", - "method": "POST", - "url": "/repos/{owner}/{repo}/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "Configures a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-github-pages-site", - "previews": [{ "name": "switcheroo" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source", - "description": "The source branch and directory used to publish your Pages site.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source.branch", - "description": "The repository branch used to publish your site's source files.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source.path", - "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["/", "/docs"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages\",\"status\":\"built\",\"cname\":\"developer.github.com\",\"custom_404\":false,\"html_url\":\"https://developer.github.com\",\"source\":{\"branch\":\"master\",\"path\":\"/\"},\"public\":true,\"https_certificate\":{\"state\":\"approved\",\"description\":\"Certificate is approved\",\"domains\":[\"developer.github.com\"],\"expires_at\":\"2021-05-22\"},\"https_enforced\":true}" - } - ] - }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a release", - "scope": "repos", - "id": "createRelease", - "method": "POST", - "url": "/repos/{owner}/{repo}/releases", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag_name", - "description": "The name of the tag.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_commitish", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the release.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "Text describing the contents of the tag.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "draft", - "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "prerelease", - "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a repository using a template", - "scope": "repos", - "id": "createUsingTemplate", - "method": "POST", - "url": "/repos/{template_owner}/{template_repo}/generate", - "isDeprecated": false, - "deprecationDate": 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. 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/enterprise-server@3.0/rest/reference/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/enterprise-server@3.0/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", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-repository-using-a-template", - "previews": [{ "name": "baptiste" }], - "headers": [], - "parameters": [ - { - "name": "template_owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "template_repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the new repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the new repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "include_all_branches", - "description": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Either `true` to create a new private repository or `false` to create a new public one.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "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\",\"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,\"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\"},\"template_repository\":{}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a repository webhook", - "scope": "repos", - "id": "createWebhook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-hook-config-params).", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "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/enterprise-server@3.0/webhooks/event-payloads) the hook is triggered for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Decline a repository invitation", - "scope": "repos", - "id": "declineInvitation", - "method": "DELETE", - "url": "/user/repository_invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#decline-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "invitation_id", - "description": "invitation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a repository", - "scope": "repos", - "id": "delete", - "method": "DELETE", - "url": "/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 307, "description": "Temporary Redirect", "examples": null }, - { - "code": 403, - "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", - "examples": [ - { - "data": "{\"message\":\"Organization members cannot delete repositories.\",\"documentation_url\":\"https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-a-repository\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete access restrictions", - "scope": "repos", - "id": "deleteAccessRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete admin branch protection", - "scope": "repos", - "id": "deleteAdminBranchProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-admin-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete branch protection", - "scope": "repos", - "id": "deleteBranchProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a commit comment", - "scope": "repos", - "id": "deleteCommitComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete commit signature protection", - "scope": "repos", - "id": "deleteCommitSignatureProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-commit-signature-protection", - "previews": [{ "name": "zzzax" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a deploy key", - "scope": "repos", - "id": "deleteDeployKey", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-a-deploy-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "key_id parameter", - "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 a deployment", - "scope": "repos", - "id": "deleteDeployment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "To ensure there can always be an active deployment, you can only delete an _inactive_ deployment. Anyone with `repo` or `repo_deployment` scopes can delete an inactive deployment.\n\nTo set a deployment as inactive, you must:\n\n* Create a new deployment that is active so that the system has a record of the current state, then delete the previously active deployment.\n* Mark the active deployment as inactive by adding any non-successful deployment status.\n\nFor more information, see \"[Create a deployment](https://docs.github.com/enterprise-server@3.0/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-deployment-status).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-a-deployment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a file", - "scope": "repos", - "id": "deleteFile", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/contents/{path}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-a-file", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "path parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The commit message.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "The blob SHA of the file being replaced.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer", - "description": "object containing information about the committer.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.email", - "description": "The email of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author", - "description": "object containing information about the author.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.email", - "description": "The email of the author (or committer) of the commit", - "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": "{\"content\":null,\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a repository invitation", - "scope": "repos", - "id": "deleteInvitation", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "invitation_id", - "description": "invitation_id parameter", - "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 a GitHub Enterprise Server Pages site", - "scope": "repos", - "id": "deletePagesSite", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-a-github-pages-site", - "previews": [{ "name": "switcheroo" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete pull request review protection", - "scope": "repos", - "id": "deletePullRequestReviewProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-pull-request-review-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a release", - "scope": "repos", - "id": "deleteRelease", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access to the repository can delete a release.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "release_id parameter", - "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 a release asset", - "scope": "repos", - "id": "deleteReleaseAsset", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "asset_id", - "description": "asset_id parameter", - "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 a repository webhook", - "scope": "repos", - "id": "deleteWebhook", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#delete-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Download a repository archive (tar)", - "scope": "repos", - "id": "downloadTarballArchive", - "method": "GET", - "url": "/repos/{owner}/{repo}/tarball/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#download-a-repository-archive", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Download a repository archive (zip)", - "scope": "repos", - "id": "downloadZipballArchive", - "method": "GET", - "url": "/repos/{owner}/{repo}/zipball/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#download-a-repository-archive", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get a repository", - "scope": "repos", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.\n\nThe `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"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\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"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\",\"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,\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}" - }, - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"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\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"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\",\"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,\"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,\"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_of_conduct\":{\"key\":\"other\",\"name\":\"Other\",\"html_url\":\"https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md\",\"url\":\"https://api.github.com/repos/github/docs/community/code_of_conduct\"}}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get access restrictions", - "scope": "repos", - "id": "getAccessRestrictions", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get admin branch protection", - "scope": "repos", - "id": "getAdminBranchProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-admin-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get all status check contexts", - "scope": "repos", - "id": "getAllStatusCheckContexts", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-all-status-check-contexts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all repository topics", - "scope": "repos", - "id": "getAllTopics", - "method": "GET", - "url": "/repos/{owner}/{repo}/topics", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-all-repository-topics", - "previews": [{ "name": "mercy" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "Get apps with access to the protected branch", - "scope": "repos", - "id": "getAppsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-apps-with-access-to-the-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a branch", - "scope": "repos", - "id": "getBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "Get branch protection", - "scope": "repos", - "id": "getBranchProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\",\"enforcement_level\":\"non_admins\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true},\"required_conversation_resolution\":{\"enabled\":true}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the weekly commit activity", - "scope": "repos", - "id": "getCodeFrequencyStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/code_frequency", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-the-weekly-commit-activity", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", - "examples": [{ "data": "[[1302998400,1124,-435]]" }] - }, - { "code": 202, "description": "Accepted", "examples": null }, - { - "code": 204, - "description": "A header with no content is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get repository permissions for a user", - "scope": "repos", - "id": "getCollaboratorPermissionLevel", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "isDeprecated": false, - "deprecationDate": null, - "description": "Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-repository-permissions-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if user has admin permissions", - "examples": [ - { - "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the combined status for a specific reference", - "scope": "repos", - "id": "getCombinedStatusForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/status", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-the-combined-status-for-a-specific-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"state\":\"success\",\"statuses\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\"},{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"id\":2,\"node_id\":\"MDY6U3RhdHVzMg==\",\"state\":\"success\",\"description\":\"Testing has completed successfully\",\"target_url\":\"https://ci.example.com/2000/output\",\"context\":\"security/brakeman\",\"created_at\":\"2012-08-20T01:19:13Z\",\"updated_at\":\"2012-08-20T01:19:13Z\"}],\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"total_count\":2,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a commit", - "scope": "repos", - "id": "getCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/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/enterprise-server@3.0/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 her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}],\"stats\":{\"additions\":104,\"deletions\":4,\"total\":108},\"files\":[{\"filename\":\"file1.txt\",\"additions\":10,\"deletions\":2,\"changes\":12,\"status\":\"modified\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"blob_url\":\"https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"patch\":\"@@ -29,7 +29,7 @@\\n.....\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the last year of commit activity", - "scope": "repos", - "id": "getCommitActivityStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/commit_activity", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-the-last-year-of-commit-activity", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"days\":[0,3,26,20,39,1,0],\"total\":89,\"week\":1336280400}]" - } - ] - }, - { "code": 202, "description": "Accepted", "examples": null }, - { - "code": 204, - "description": "A header with no content is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a commit comment", - "scope": "repos", - "id": "getCommitComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author_association\":\"COLLABORATOR\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get commit signature protection", - "scope": "repos", - "id": "getCommitSignatureProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-commit-signature-protection", - "previews": [{ "name": "zzzax" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\"enabled\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get repository content", - "scope": "repos", - "id": "getContent", - "method": "GET", - "url": "/repos/{owner}/{repo}/contents/{path}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types) to ensure the content is returned in a consistent\nobject format.\n\n**Note**:\n* To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/enterprise-server@3.0/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.0/rest/reference/git#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-repository-content", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "path parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" - }, - { - "data": "[{\"type\":\"file\",\"size\":625,\"name\":\"octokit.rb\",\"path\":\"lib/octokit.rb\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb\",\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"octokit\",\"path\":\"lib/octokit\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\"}}]" - }, - { - "data": "{\"type\":\"symlink\",\"target\":\"/path/to/symlink/target\",\"size\":23,\"name\":\"some-symlink\",\"path\":\"bin/some-symlink\",\"sha\":\"452a98979c88e093d682cab404a3ec82babebb48\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\"}}" - }, - { - "data": "{\"type\":\"submodule\",\"submodule_git_url\":\"git://github.com/jquery/qunit.git\",\"size\":0,\"name\":\"qunit\",\"path\":\"test/qunit\",\"sha\":\"6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"url\":\"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\"git_url\":\"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"html_url\":\"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"download_url\":null,\"_links\":{\"git\":\"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"self\":\"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\"html\":\"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\"}}" - } - ] - }, - { "code": 302, "description": "Found", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all contributor commit activity", - "scope": "repos", - "id": "getContributorsStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/contributors", - "isDeprecated": false, - "deprecationDate": 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", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-all-contributor-commit-activity", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "* `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", - "examples": [ - { - "data": "[{\"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},\"total\":135,\"weeks\":[{\"w\":1367712000,\"a\":6898,\"d\":77,\"c\":10}]}]" - } - ] - }, - { "code": 202, "description": "Accepted", "examples": null }, - { - "code": 204, - "description": "A header with no content is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a deploy key", - "scope": "repos", - "id": "getDeployKey", - "method": "GET", - "url": "/repos/{owner}/{repo}/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-deploy-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "key_id parameter", - "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\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a deployment", - "scope": "repos", - "id": "getDeployment", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-deployment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a deployment status", - "scope": "repos", - "id": "getDeploymentStatus", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with pull access can view a deployment status for a deployment:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-deployment-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"https://test-branch.lab.acme.com\",\"log_url\":\"https://example.com/deployment/42/output\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "Get latest Pages build", - "scope": "repos", - "id": "getLatestPagesBuild", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds/latest", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-latest-pages-build", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the latest release", - "scope": "repos", - "id": "getLatestRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/latest", - "isDeprecated": false, - "deprecationDate": null, - "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-the-latest-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a GitHub Enterprise Server Pages site", - "scope": "repos", - "id": "getPages", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-github-pages-site", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages\",\"status\":\"built\",\"cname\":\"developer.github.com\",\"custom_404\":false,\"html_url\":\"https://developer.github.com\",\"source\":{\"branch\":\"master\",\"path\":\"/\"},\"public\":true,\"https_certificate\":{\"state\":\"approved\",\"description\":\"Certificate is approved\",\"domains\":[\"developer.github.com\"],\"expires_at\":\"2021-05-22\"},\"https_enforced\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get GitHub Enterprise Server Pages build", - "scope": "repos", - "id": "getPagesBuild", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-github-pages-build", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "build_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the weekly commit count", - "scope": "repos", - "id": "getParticipationStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/participation", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-the-weekly-commit-count", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The array order is oldest week (index 0) to most recent week.", - "examples": [ - { - "data": "{\"all\":[11,21,15,2,8,1,8,23,17,21,11,10,33,91,38,34,22,23,32,3,43,87,71,18,13,5,13,16,66,27,12,45,110,117,13,8,18,9,19,26,39,12,20,31,46,91,45,10,24,9,29,7],\"owner\":[3,2,3,0,2,0,5,14,7,9,1,5,0,48,19,2,0,1,10,2,23,40,35,8,8,2,10,6,30,0,2,9,53,104,3,3,10,4,7,11,21,4,4,22,26,63,11,2,14,1,10,3]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get pull request review protection", - "scope": "repos", - "id": "getPullRequestReviewProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-pull-request-review-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the hourly commit count for each day", - "scope": "repos", - "id": "getPunchCardStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/punch_card", - "isDeprecated": false, - "deprecationDate": null, - "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-the-hourly-commit-count-for-each-day", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", - "examples": [{ "data": "[[0,0,5],[0,1,43],[0,2,21]]" }] - }, - { - "code": 204, - "description": "A header with no content is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a repository README", - "scope": "repos", - "id": "getReadme", - "method": "GET", - "url": "/repos/{owner}/{repo}/readme", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository-readme", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a repository README for a directory", - "scope": "repos", - "id": "getReadmeInDirectory", - "method": "GET", - "url": "/repos/{owner}/{repo}/readme/{dir}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository-directory-readme", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dir", - "description": "The alternate path to look for a README file", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a release", - "scope": "repos", - "id": "getRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#hypermedia).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "release_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#hypermedia).", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a release asset", - "scope": "repos", - "id": "getReleaseAsset", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "asset_id", - "description": "asset_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 302, "description": "Found", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a release by tag name", - "scope": "repos", - "id": "getReleaseByTag", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/tags/{tag}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get a published release with the specified tag.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-release-by-tag-name", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag", - "description": "tag parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get status checks protection", - "scope": "repos", - "id": "getStatusChecksProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-status-checks-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get teams with access to the protected branch", - "scope": "repos", - "id": "getTeamsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-teams-with-access-to-the-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get users with access to the protected branch", - "scope": "repos", - "id": "getUsersWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-users-with-access-to-the-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a repository webhook", - "scope": "repos", - "id": "getWebhook", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a webhook configuration for a repository", - "scope": "repos", - "id": "getWebhookConfigForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "isDeprecated": false, - "deprecationDate": 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/reference/orgs#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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-webhook-configuration-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List branches", - "scope": "repos", - "id": "listBranches", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-branches", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "protected", - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"name\":\"master\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"protected\":true,\"protection\":{\"required_status_checks\":{\"enforcement_level\":\"non_admins\",\"contexts\":[\"ci-test\",\"linter\"]}},\"protection_url\":\"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List branches for HEAD commit", - "scope": "repos", - "id": "listBranchesForHeadCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-branches-for-head-commit", - "previews": [{ "name": "groot" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "commit_sha parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"name\":\"branch_5\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"protected\":false}]" - } - ] - }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository collaborators", - "scope": "repos", - "id": "listCollaborators", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-repository-collaborators", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "affiliation", - "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["outside", "direct", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"permissions\":{\"pull\":true,\"push\":true,\"admin\":false}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List commit comments", - "scope": "repos", - "id": "listCommentsForCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Use the `:commit_sha` to specify the commit that will have its comments listed.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-commit-comments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "commit_sha parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List commit comments for a repository", - "scope": "repos", - "id": "listCommitCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Commit Comments use [these custom media types](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types/).\n\nComments are ordered by ascending ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-commit-comments-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List commit statuses for a reference", - "scope": "repos", - "id": "listCommitStatusesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-commit-statuses-for-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null } - ], - "renamed": null - }, - { - "name": "List commits", - "scope": "repos", - "id": "listCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "Only commits containing this file path will be returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author", - "description": "GitHub login or email address by which to filter by commit author.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}]" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository contributors", - "scope": "repos", - "id": "listContributors", - "method": "GET", - "url": "/repos/{owner}/{repo}/contributors", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-repository-contributors", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "anon", - "description": "Set to `1` or `true` to include anonymous contributors in results.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if repository contains content", - "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,\"contributions\":32}]" - } - ] - }, - { - "code": 204, - "description": "Response if repository is empty", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List deploy keys", - "scope": "repos", - "id": "listDeployKeys", - "method": "GET", - "url": "/repos/{owner}/{repo}/keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-deploy-keys", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List deployment statuses", - "scope": "repos", - "id": "listDeploymentStatuses", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with pull access can view deployment statuses for a deployment:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-deployment-statuses", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"https://test-branch.lab.acme.com\",\"log_url\":\"https://example.com/deployment/42/output\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List deployments", - "scope": "repos", - "id": "listDeployments", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Simple filtering of deployments is available via query parameters:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-deployments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "The SHA recorded at creation time.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the ref. This can be a branch, tag, or SHA.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "task", - "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories for the authenticated user", - "scope": "repos", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists repositories 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-repositories-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "public", "private"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "affiliation", - "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "owner", "public", "private", "member"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "pushed", "full_name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List organization repositories", - "scope": "repos", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists repositories for the specified organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-organization-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "all", - "public", - "private", - "forks", - "sources", - "member", - "internal" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "pushed", "full_name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories for a user", - "scope": "repos", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-repositories-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "type", - "description": "Can be one of `all`, `owner`, `member`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "owner", "member"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "pushed", "full_name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List forks", - "scope": "repos", - "id": "listForks", - "method": "GET", - "url": "/repos/{owner}/{repo}/forks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-forks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["newest", "oldest", "stargazers", "watchers"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository invitations", - "scope": "repos", - "id": "listInvitations", - "method": "GET", - "url": "/repos/{owner}/{repo}/invitations", - "isDeprecated": false, - "deprecationDate": null, - "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-repository-invitations", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\",\"node_id\":\"MDQ6VXNlcjE=\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository invitations for the authenticated user", - "scope": "repos", - "id": "listInvitationsForAuthenticatedUser", - "method": "GET", - "url": "/user/repository_invitations", - "isDeprecated": false, - "deprecationDate": null, - "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-repository-invitations-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\",\"node_id\":\"MDQ6VXNlcjE=\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository languages", - "scope": "repos", - "id": "listLanguages", - "method": "GET", - "url": "/repos/{owner}/{repo}/languages", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-repository-languages", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "{\"C\":78769,\"Python\":7769}" }] - } - ], - "renamed": null - }, - { - "name": "List GitHub Enterprise Server Pages builds", - "scope": "repos", - "id": "listPagesBuilds", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-github-pages-builds", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public repositories", - "scope": "repos", - "id": "listPublic", - "method": "GET", - "url": "/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-public-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "A repository ID. Only return repositories with an ID greater than this ID.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "public"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List pull requests associated with a commit", - "scope": "repos", - "id": "listPullRequestsAssociatedWithCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-pull-requests) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-pull-requests-associated-with-a-commit", - "previews": [{ "name": "groot" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "commit_sha parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false}]" - } - ] - }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "List release assets", - "scope": "repos", - "id": "listReleaseAssets", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-release-assets", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "release_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/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}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List releases", - "scope": "repos", - "id": "listReleases", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases", - "isDeprecated": false, - "deprecationDate": null, - "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-releases", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository tags", - "scope": "repos", - "id": "listTags", - "method": "GET", - "url": "/repos/{owner}/{repo}/tags", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-repository-tags", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"name\":\"v0.1\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"zipball_url\":\"https://github.com/octocat/Hello-World/zipball/v0.1\",\"tarball_url\":\"https://github.com/octocat/Hello-World/tarball/v0.1\",\"node_id\":\"MDQ6VXNlcjE=\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository teams", - "scope": "repos", - "id": "listTeams", - "method": "GET", - "url": "/repos/{owner}/{repo}/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-repository-teams", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository webhooks", - "scope": "repos", - "id": "listWebhooks", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-repository-webhooks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Merge a branch", - "scope": "repos", - "id": "merge", - "method": "POST", - "url": "/repos/{owner}/{repo}/merges", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#merge-a-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "The name of the base branch that the head will be merged into.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "The head to merge. This can be a branch name or a commit SHA1.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_message", - "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Successful Response (The resulting merge commit)", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}],\"stats\":{\"additions\":104,\"deletions\":4,\"total\":108},\"files\":[{\"filename\":\"file1.txt\",\"additions\":10,\"deletions\":2,\"changes\":12,\"status\":\"modified\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"blob_url\":\"https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"patch\":\"@@ -29,7 +29,7 @@\\n.....\"}]}" - } - ] - }, - { - "code": 204, - "description": "Response when already merged", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found when the base or head does not exist", - "examples": null - }, - { - "code": 409, - "description": "Conflict when there is a merge conflict", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Ping a repository webhook", - "scope": "repos", - "id": "pingWebhook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "isDeprecated": false, - "deprecationDate": null, - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.0/webhooks/#ping-event) to be sent to the hook.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#ping-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove app access restrictions", - "scope": "repos", - "id": "removeAppAccessRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#remove-app-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "apps", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove a repository collaborator", - "scope": "repos", - "id": "removeCollaborator", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#remove-a-repository-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "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 status check contexts", - "scope": "repos", - "id": "removeStatusCheckContexts", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#remove-status-check-contexts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove status check protection", - "scope": "repos", - "id": "removeStatusCheckProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#remove-status-check-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove team access restrictions", - "scope": "repos", - "id": "removeTeamAccessRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#remove-team-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "teams", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove user access restrictions", - "scope": "repos", - "id": "removeUserAccessRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#remove-user-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "users", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Replace all repository topics", - "scope": "repos", - "id": "replaceAllTopics", - "method": "PUT", - "url": "/repos/{owner}/{repo}/topics", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#replace-all-repository-topics", - "previews": [{ "name": "mercy" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "names", - "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Request a GitHub Enterprise Server Pages build", - "scope": "repos", - "id": "requestPagesBuild", - "method": "POST", - "url": "/repos/{owner}/{repo}/pages/builds", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#request-a-github-pages-build", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/latest\",\"status\":\"queued\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set admin branch protection", - "scope": "repos", - "id": "setAdminBranchProtection", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#set-admin-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set app access restrictions", - "scope": "repos", - "id": "setAppAccessRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#set-app-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "apps", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Set status check contexts", - "scope": "repos", - "id": "setStatusCheckContexts", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#set-status-check-contexts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Set team access restrictions", - "scope": "repos", - "id": "setTeamAccessRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#set-team-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "teams", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Set user access restrictions", - "scope": "repos", - "id": "setUserAccessRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#set-user-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "users", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Test the push repository webhook", - "scope": "repos", - "id": "testPushWebhook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "isDeprecated": false, - "deprecationDate": null, - "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#test-the-push-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Transfer a repository", - "scope": "repos", - "id": "transfer", - "method": "POST", - "url": "/repos/{owner}/{repo}/transfer", - "isDeprecated": false, - "deprecationDate": null, - "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#transfer-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "new_owner", - "description": "The username or organization name the repository will be transferred to.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_ids", - "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "in": "BODY", - "type": "integer[]", - "required": false, - "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\",\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a repository", - "scope": "repos", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#replace-all-repository-topics) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos/#update-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "homepage", - "description": "A URL with more information about the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["public", "private", "visibility", "internal"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_issues", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_projects", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_wiki", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "is_template", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "default_branch", - "description": "Updates the default branch for this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_squash_merge", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_merge_commit", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_rebase_merge", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delete_branch_on_merge", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "archived", - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks_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\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"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\",\"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,\"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,\"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": 307, "description": "Temporary Redirect", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update branch protection", - "scope": "repos", - "id": "updateBranchProtection", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks", - "description": "Require status checks to pass before merging. Set to `null` to disable.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.strict", - "description": "Require branches to be up to date before merging.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.contexts", - "description": "The list of status checks to require in order to merge into this branch", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforce_admins", - "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews", - "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismissal_restrictions", - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismissal_restrictions.users", - "description": "The list of user `login`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismissal_restrictions.teams", - "description": "The list of team `slug`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismiss_stale_reviews", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.required_approving_review_count", - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "restrictions", - "description": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "restrictions.users", - "description": "The list of user `login`s with push access", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "restrictions.teams", - "description": "The list of team `slug`s with push access", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "restrictions.apps", - "description": "The list of app `slug`s with push access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_linear_history", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_force_pushes", - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_deletions", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_conversation_resolution", - "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a commit comment", - "scope": "repos", - "id": "updateCommitComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Nice change\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author_association\":\"COLLABORATOR\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update information about a GitHub Enterprise Server Pages site", - "scope": "repos", - "id": "updateInformationAboutPagesSite", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-information-about-a-github-pages-site", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "cname", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "https_enforced", - "description": "Specify whether HTTPS should be enforced for the repository.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "public", - "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a repository invitation", - "scope": "repos", - "id": "updateInvitation", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "invitation_id", - "description": "invitation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions", - "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "maintain", "triage", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"expired\":false,\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update pull request review protection", - "scope": "repos", - "id": "updatePullRequestReviewProtection", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-pull-request-review-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissal_restrictions", - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissal_restrictions.users", - "description": "The list of user `login`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissal_restrictions.teams", - "description": "The list of team `slug`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismiss_stale_reviews", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_approving_review_count", - "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" - } - ] - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a release", - "scope": "repos", - "id": "updateRelease", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access to the repository can edit a release.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "release_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag_name", - "description": "The name of the tag.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_commitish", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the release.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "Text describing the contents of the tag.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "draft", - "description": "`true` makes the release a draft, and `false` publishes the release.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "prerelease", - "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/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}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a release asset", - "scope": "repos", - "id": "updateReleaseAsset", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access to the repository can edit a release asset.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "asset_id", - "description": "asset_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The file name of the asset.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "label", - "description": "An alternate short description of the asset. Used in place of the filename.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "", - "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": "{\"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}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update status check protection", - "scope": "repos", - "id": "updateStatusCheckProtection", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-status-check-potection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "strict", - "description": "Require branches to be up to date before merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "The list of status checks to require in order to merge into this branch", - "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": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a repository webhook", - "scope": "repos", - "id": "updateWebhook", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-hook-config-params).", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "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/enterprise-server@3.0/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "add_events", - "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "remove_events", - "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a webhook configuration for a repository", - "scope": "repos", - "id": "updateWebhookConfigForRepo", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "isDeprecated": false, - "deprecationDate": 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/reference/orgs#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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#update-a-webhook-configuration-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.0/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Upload a release asset", - "scope": "repos", - "id": "uploadReleaseAsset", - "method": "POST", - "url": "{origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint makes use of [a Hypermedia relation](https://docs.github.com/enterprise-server@3.0/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/enterprise-server@3.0/rest/reference/repos#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 Enterprise Server 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 Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#list-assets-for-a-release)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=rest-api).\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/enterprise-server@3.0/rest/reference/repos#upload-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "release_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "label", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "data", - "description": "The raw file data", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint", - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response for successful upload", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Search code", - "scope": "search", - "id": "code", - "method": "GET", - "url": "/search/code", - "isDeprecated": false, - "deprecationDate": null, - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.0/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/enterprise-server@3.0/rest/reference/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\n#### Considerations 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/search#search-code", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.0/rest/reference/search#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.0/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["indexed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":7,\"incomplete_results\":false,\"items\":[{\"name\":\"classes.js\",\"path\":\"src/attributes/classes.js\",\"sha\":\"d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\"url\":\"https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4\",\"git_url\":\"https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\"html_url\":\"https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js\",\"repository\":{\"id\":167174,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxNjcxNzQ=\",\"name\":\"jquery\",\"full_name\":\"jquery/jquery\",\"owner\":{\"login\":\"jquery\",\"id\":70142,\"node_id\":\"MDQ6VXNlcjcwMTQy\",\"avatar_url\":\"https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/jquery\",\"html_url\":\"https://github.com/jquery\",\"followers_url\":\"https://api.github.com/users/jquery/followers\",\"following_url\":\"https://api.github.com/users/jquery/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/jquery/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/jquery/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/jquery/subscriptions\",\"organizations_url\":\"https://api.github.com/users/jquery/orgs\",\"repos_url\":\"https://api.github.com/users/jquery/repos\",\"events_url\":\"https://api.github.com/users/jquery/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/jquery/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/jquery/jquery\",\"description\":\"jQuery JavaScript Library\",\"fork\":false,\"url\":\"https://api.github.com/repos/jquery/jquery\",\"forks_url\":\"https://api.github.com/repos/jquery/jquery/forks\",\"keys_url\":\"https://api.github.com/repos/jquery/jquery/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/jquery/jquery/teams\",\"hooks_url\":\"https://api.github.com/repos/jquery/jquery/hooks\",\"issue_events_url\":\"https://api.github.com/repos/jquery/jquery/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/jquery/jquery/events\",\"assignees_url\":\"https://api.github.com/repos/jquery/jquery/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/jquery/jquery/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/jquery/jquery/tags\",\"blobs_url\":\"https://api.github.com/repos/jquery/jquery/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/jquery/jquery/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/jquery/jquery/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/jquery/jquery/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/jquery/jquery/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/jquery/jquery/languages\",\"stargazers_url\":\"https://api.github.com/repos/jquery/jquery/stargazers\",\"contributors_url\":\"https://api.github.com/repos/jquery/jquery/contributors\",\"subscribers_url\":\"https://api.github.com/repos/jquery/jquery/subscribers\",\"subscription_url\":\"https://api.github.com/repos/jquery/jquery/subscription\",\"commits_url\":\"https://api.github.com/repos/jquery/jquery/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/jquery/jquery/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/jquery/jquery/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/jquery/jquery/issues/comments/{number}\",\"contents_url\":\"https://api.github.com/repos/jquery/jquery/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/jquery/jquery/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/jquery/jquery/merges\",\"archive_url\":\"https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/jquery/jquery/downloads\",\"issues_url\":\"https://api.github.com/repos/jquery/jquery/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/jquery/jquery/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/jquery/jquery/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/jquery/jquery/labels{/name}\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\"},\"score\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Search commits", - "scope": "search", - "id": "commits", - "method": "GET", - "url": "/search/commits", - "isDeprecated": false, - "deprecationDate": null, - "description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.0/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/enterprise-server@3.0/rest/reference/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/enterprise-server@3.0/rest/reference/search#search-commits", - "previews": [{ "name": "cloak" }], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.0/rest/reference/search#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.0/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["author-date", "committer-date"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"sha\":\"bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"author\":{\"date\":\"2014-02-04T14:38:36-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"date\":\"2014-02-12T15:18:55-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"message\":\"Create styles.css and updated README\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68\",\"sha\":\"a639e96f9038797fba6e0469f94a4b0cc459fa68\"},\"comment_count\":8},\"author\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"sha\":\"a30c19e3f13765a3b48829788bc1cb8b4e95cee4\"}],\"repository\":{\"id\":1300192,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMzAwMTky\",\"name\":\"Spoon-Knife\",\"full_name\":\"octocat/Spoon-Knife\",\"owner\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Spoon-Knife\",\"description\":\"This repo is for demonstration purposes only.\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife\",\"forks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/forks\",\"keys_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/teams\",\"hooks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/events\",\"assignees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/tags\",\"blobs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/languages\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscription\",\"commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/merges\",\"archive_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/downloads\",\"issues_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/deployments\"},\"score\":1,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\"}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "Search issues and pull requests", - "scope": "search", - "id": "issuesAndPullRequests", - "method": "GET", - "url": "/search/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.0/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/enterprise-server@3.0/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/search#search-issues-and-pull-requests", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.0/rest/reference/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.0/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":280,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132\",\"repository_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit\",\"labels_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments\",\"events_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events\",\"html_url\":\"https://github.com/batterseapower/pinyin-toolkit/issues/132\",\"id\":35802,\"node_id\":\"MDU6SXNzdWUzNTgwMg==\",\"number\":132,\"title\":\"Line Number Indexes Beyond 20 Not Displayed\",\"user\":{\"login\":\"Nick3C\",\"id\":90254,\"node_id\":\"MDQ6VXNlcjkwMjU0\",\"avatar_url\":\"https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/Nick3C\",\"html_url\":\"https://github.com/Nick3C\",\"followers_url\":\"https://api.github.com/users/Nick3C/followers\",\"following_url\":\"https://api.github.com/users/Nick3C/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/Nick3C/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/Nick3C/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/Nick3C/subscriptions\",\"organizations_url\":\"https://api.github.com/users/Nick3C/orgs\",\"repos_url\":\"https://api.github.com/users/Nick3C/repos\",\"events_url\":\"https://api.github.com/users/Nick3C/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/Nick3C/received_events\",\"type\":\"User\",\"site_admin\":true},\"labels\":[{\"id\":4,\"node_id\":\"MDU6TGFiZWw0\",\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug\",\"name\":\"bug\",\"color\":\"ff0000\"}],\"state\":\"open\",\"assignee\":null,\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"comments\":15,\"created_at\":\"2009-07-12T20:10:41Z\",\"updated_at\":\"2009-07-19T09:23:43Z\",\"closed_at\":null,\"pull_request\":{\"url\":\"https://api/github.com/repos/octocat/Hello-World/pull/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"body\":\"...\",\"score\":1,\"locked\":true,\"author_association\":\"COLLABORATOR\"}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Search labels", - "scope": "search", - "id": "labels", - "method": "GET", - "url": "/search/labels", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.0/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/enterprise-server@3.0/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/search#search-labels", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The id of the repository.", - "in": "QUERY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.0/rest/reference/search#constructing-a-search-query).", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.0/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"incomplete_results\":false,\"items\":[{\"id\":418327088,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODg=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/enhancement\",\"name\":\"enhancement\",\"color\":\"84b6eb\",\"default\":true,\"description\":\"New feature or request.\",\"score\":1},{\"id\":418327086,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODY=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/bug\",\"name\":\"bug\",\"color\":\"ee0701\",\"default\":true,\"description\":\"Something isn't working.\",\"score\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Search repositories", - "scope": "search", - "id": "repos", - "method": "GET", - "url": "/search/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.0/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/enterprise-server@3.0/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.\n\nWhen you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:\n\n`q=topic:ruby+topic:rails`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/search#search-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.0/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.0/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["stars", "forks", "help-wanted-issues", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":40,\"incomplete_results\":false,\"items\":[{\"id\":3081286,\"node_id\":\"MDEwOlJlcG9zaXRvcnkzMDgxMjg2\",\"name\":\"Tetris\",\"full_name\":\"dtrupenn/Tetris\",\"owner\":{\"login\":\"dtrupenn\",\"id\":872147,\"node_id\":\"MDQ6VXNlcjg3MjE0Nw==\",\"avatar_url\":\"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/dtrupenn\",\"received_events_url\":\"https://api.github.com/users/dtrupenn/received_events\",\"type\":\"User\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"site_admin\":true},\"private\":false,\"html_url\":\"https://github.com/dtrupenn/Tetris\",\"description\":\"A C implementation of Tetris using Pennsim through LC4\",\"fork\":false,\"url\":\"https://api.github.com/repos/dtrupenn/Tetris\",\"created_at\":\"2012-01-01T00:31:50Z\",\"updated_at\":\"2013-01-05T17:58:47Z\",\"pushed_at\":\"2012-01-01T00:37:02Z\",\"homepage\":\"https://github.com\",\"size\":524,\"stargazers_count\":1,\"watchers_count\":1,\"language\":\"Assembly\",\"forks_count\":0,\"open_issues_count\":0,\"master_branch\":\"master\",\"default_branch\":\"master\",\"score\":1,\"archive_url\":\"https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contributors\",\"deployments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/deployments\",\"downloads_url\":\"https://api.github.com/repos/dtrupenn/Tetris/downloads\",\"events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/events\",\"forks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/forks\",\"git_commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}\",\"git_url\":\"git:github.com/dtrupenn/Tetris.git\",\"issue_comment_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/dtrupenn/Tetris/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/dtrupenn/Tetris/languages\",\"merges_url\":\"https://api.github.com/repos/dtrupenn/Tetris/merges\",\"milestones_url\":\"https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/dtrupenn/Tetris/releases{/id}\",\"ssh_url\":\"git@github.com:dtrupenn/Tetris.git\",\"stargazers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/stargazers\",\"statuses_url\":\"https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscribers\",\"subscription_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscription\",\"tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/tags\",\"teams_url\":\"https://api.github.com/repos/dtrupenn/Tetris/teams\",\"trees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}\",\"clone_url\":\"https://github.com/dtrupenn/Tetris.git\",\"mirror_url\":\"git:git.example.com/dtrupenn/Tetris\",\"hooks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/hooks\",\"svn_url\":\"https://svn.github.com/dtrupenn/Tetris\",\"forks\":1,\"open_issues\":1,\"watchers\":1,\"has_issues\":true,\"has_projects\":true,\"has_pages\":true,\"has_wiki\":true,\"has_downloads\":true,\"archived\":true,\"disabled\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"}}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Search topics", - "scope": "search", - "id": "topics", - "method": "GET", - "url": "/search/topics", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#pagination). See \"[Searching topics](https://help.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.0/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/search#search-topics", - "previews": [{ "name": "mercy" }], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.0/rest/reference/search#constructing-a-search-query).", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":6,\"incomplete_results\":false,\"items\":[{\"name\":\"ruby\",\"display_name\":\"Ruby\",\"short_description\":\"Ruby is a scripting language designed for simplified object-oriented programming.\",\"description\":\"Ruby was developed by Yukihiro \\\"Matz\\\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.\",\"created_by\":\"Yukihiro Matsumoto\",\"released\":\"December 21, 1995\",\"created_at\":\"2016-11-28T22:03:59Z\",\"updated_at\":\"2017-10-30T18:16:32Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"rails\",\"display_name\":\"Rails\",\"short_description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby.\",\"description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.\",\"created_by\":\"David Heinemeier Hansson\",\"released\":\"December 13 2005\",\"created_at\":\"2016-12-09T17:03:50Z\",\"updated_at\":\"2017-10-30T16:20:19Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"python\",\"display_name\":\"Python\",\"short_description\":\"Python is a dynamically typed programming language.\",\"description\":\"Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.\",\"created_by\":\"Guido van Rossum\",\"released\":\"February 20, 1991\",\"created_at\":\"2016-12-07T00:07:02Z\",\"updated_at\":\"2017-10-27T22:45:43Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"jekyll\",\"display_name\":\"Jekyll\",\"short_description\":\"Jekyll is a simple, blog-aware static site generator.\",\"description\":\"Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.\",\"created_by\":\"Tom Preston-Werner\",\"released\":\"2008\",\"created_at\":\"2016-12-16T21:53:08Z\",\"updated_at\":\"2017-10-27T19:00:24Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"sass\",\"display_name\":\"Sass\",\"short_description\":\"Sass is a stable extension to classic CSS.\",\"description\":\"Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.\",\"created_by\":\"Hampton Catlin, Natalie Weizenbaum, Chris Eppstein\",\"released\":\"November 28, 2006\",\"created_at\":\"2016-12-16T21:53:45Z\",\"updated_at\":\"2018-01-16T16:30:40Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"homebrew\",\"display_name\":\"Homebrew\",\"short_description\":\"Homebrew is a package manager for macOS.\",\"description\":\"Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.\",\"created_by\":\"Max Howell\",\"released\":\"2009\",\"created_at\":\"2016-12-17T20:30:44Z\",\"updated_at\":\"2018-02-06T16:14:56Z\",\"featured\":true,\"curated\":true,\"score\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "Search users", - "scope": "search", - "id": "users", - "method": "GET", - "url": "/search/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.0/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.0/rest/reference/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/search#search-users", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.0/rest/reference/search#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.0/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["followers", "repositories", "joined"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":12,\"incomplete_results\":false,\"items\":[{\"login\":\"mojombo\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/mojombo\",\"html_url\":\"https://github.com/mojombo\",\"followers_url\":\"https://api.github.com/users/mojombo/followers\",\"subscriptions_url\":\"https://api.github.com/users/mojombo/subscriptions\",\"organizations_url\":\"https://api.github.com/users/mojombo/orgs\",\"repos_url\":\"https://api.github.com/users/mojombo/repos\",\"received_events_url\":\"https://api.github.com/users/mojombo/received_events\",\"type\":\"User\",\"score\":1,\"following_url\":\"https://api.github.com/users/mojombo/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/mojombo/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/mojombo/starred{/owner}{/repo}\",\"events_url\":\"https://api.github.com/users/mojombo/events{/privacy}\",\"site_admin\":true}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Add team member (Legacy)", - "scope": "teams", - "id": "addMemberLegacy", - "method": "PUT", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-21", - "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/enterprise-server@3.0/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#add-team-member-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "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 }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if team synchronization is set up", - "examples": null - }, - { - "code": 422, - "description": "Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add or update team membership for a user", - "scope": "teams", - "id": "addOrUpdateMembershipForUserInOrg", - "method": "PUT", - "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#add-or-update-team-membership-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["member", "maintainer"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" - } - ] - }, - { - "code": 403, - "description": "Forbidden if team synchronization is set up", - "examples": null - }, - { - "code": 422, - "description": "Unprocessable Entity if you attempt to add an organization to a team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add or update team membership for a user (Legacy)", - "scope": "teams", - "id": "addOrUpdateMembershipForUserLegacy", - "method": "PUT", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["member", "maintainer"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" - } - ] - }, - { - "code": 403, - "description": "Forbidden if team synchronization is set up", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Unprocessable Entity if you attempt to add an organization to a team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add or update team project permissions", - "scope": "teams", - "id": "addOrUpdateProjectPermissionsInOrg", - "method": "PUT", - "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\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}/projects/{project_id}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#add-or-update-team-project-permissions", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 403, - "description": "Forbidden if the project is not owned by the organization", - "examples": [ - { - "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://docs.github.com/enterprise-server@3.0/rest/reference/teams#add-or-update-team-project-permissions\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add or update team project permissions (Legacy)", - "scope": "teams", - "id": "addOrUpdateProjectPermissionsLegacy", - "method": "PUT", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Add or update team project permissions](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#add-or-update-team-project-permissions-legacy", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 403, - "description": "Forbidden if the project is not owned by the organization", - "examples": [ - { - "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://docs.github.com/enterprise-server@3.0/rest/reference/teams#add-or-update-team-project-permissions\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Add or update team repository permissions", - "scope": "teams", - "id": "addOrUpdateRepoPermissionsInOrg", - "method": "PUT", - "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#add-or-update-team-repository-permissions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n\\* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. \n\\* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin", "maintain", "triage"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Add or update team repository permissions (Legacy)", - "scope": "teams", - "id": "addOrUpdateRepoPermissionsLegacy", - "method": "PUT", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.0/rest/reference/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/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#add-or-update-team-repository-permissions-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Check team permissions for a project", - "scope": "teams", - "id": "checkPermissionsForProjectInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\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}/projects/{project_id}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#check-team-permissions-for-a-project", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}" - } - ] - }, - { - "code": 404, - "description": "Not Found if project is not managed by this team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check team permissions for a project (Legacy)", - "scope": "teams", - "id": "checkPermissionsForProjectLegacy", - "method": "GET", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Check team permissions for a project](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#check-team-permissions-for-a-project-legacy", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}" - } - ] - }, - { - "code": 404, - "description": "Not Found if project is not managed by this team", - "examples": null - }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "Check team permissions for a repository", - "scope": "teams", - "id": "checkPermissionsForRepoInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#check-team-permissions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Alternative response with repository permissions", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"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": 204, - "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header.", - "examples": null - }, - { - "code": 404, - "description": "Not Found if team does not have permission for the repository", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check team permissions for a repository (Legacy)", - "scope": "teams", - "id": "checkPermissionsForRepoLegacy", - "method": "GET", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "deprecationDate": "2020-01-21", - "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**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 [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#check-team-permissions-for-a-repository) endpoint.\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/enterprise-server@3.0/rest/overview/media-types/) via the `Accept` header:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#check-team-permissions-for-a-repository-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Alternative response with extra repository information", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"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": 204, - "description": "Response if repository is managed by this team", - "examples": null - }, - { - "code": 404, - "description": "Not Found if repository is not managed by this team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a team", - "scope": "teams", - "id": "create", - "method": "POST", - "url": "/orgs/{org}/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the team.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "maintainers", - "description": "List GitHub IDs for organization members who will become team maintainers.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo_names", - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "privacy", - "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["secret", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a discussion comment", - "scope": "teams", - "id": "createDiscussionCommentInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-discussion-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a discussion comment (Legacy)", - "scope": "teams", - "id": "createDiscussionCommentLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "isDeprecated": true, - "deprecationDate": "2020-01-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 a discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a discussion", - "scope": "teams", - "id": "createDiscussionInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-discussion", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion post's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a discussion (Legacy)", - "scope": "teams", - "id": "createDiscussionLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions", - "isDeprecated": true, - "deprecationDate": "2020-01-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 a discussion`](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.0/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion post's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a discussion comment", - "scope": "teams", - "id": "deleteDiscussionCommentInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#delete-a-discussion-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "", - "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 a discussion comment (Legacy)", - "scope": "teams", - "id": "deleteDiscussionCommentLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Delete a discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#delete-a-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "", - "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 a discussion", - "scope": "teams", - "id": "deleteDiscussionInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#delete-a-discussion", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "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 a discussion (Legacy)", - "scope": "teams", - "id": "deleteDiscussionLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [`Delete a discussion`](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#delete-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "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 a team", - "scope": "teams", - "id": "deleteInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}", - "isDeprecated": false, - "deprecationDate": null, - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#delete-a-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "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": "Delete a team (Legacy)", - "scope": "teams", - "id": "deleteLegacy", - "method": "DELETE", - "url": "/teams/{team_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Delete a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#delete-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a team by name", - "scope": "teams", - "id": "getByName", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a team using the team's `slug`. GitHub Enterprise Server generates the `slug` from the team `name`.\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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-a-team-by-name", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a discussion comment", - "scope": "teams", - "id": "getDiscussionCommentInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-a-discussion-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a discussion comment (Legacy)", - "scope": "teams", - "id": "getDiscussionCommentLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Get a discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-a-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a discussion", - "scope": "teams", - "id": "getDiscussionInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-a-discussion", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a discussion (Legacy)", - "scope": "teams", - "id": "getDiscussionLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Get a discussion](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a team (Legacy)", - "scope": "teams", - "id": "getLegacy", - "method": "GET", - "url": "/teams/{team_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Get a team by name](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-a-team-by-name) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#get-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get team member (Legacy)", - "scope": "teams", - "id": "getMemberLegacy", - "method": "GET", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-21", - "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-team-member-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "if user is a member", "examples": null }, - { - "code": 404, - "description": "if user is not a member", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get team membership for a user", - "scope": "teams", - "id": "getMembershipForUserInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\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}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-team).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-team-membership-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"maintainer\",\"state\":\"active\"}" - } - ] - }, - { - "code": 404, - "description": "if user has no team membership", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get team membership for a user (Legacy)", - "scope": "teams", - "id": "getMembershipForUserLegacy", - "method": "GET", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Get team membership for a user](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#create-a-team).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#get-team-membership-for-a-user-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"maintainer\",\"state\":\"active\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List teams", - "scope": "teams", - "id": "list", - "method": "GET", - "url": "/orgs/{org}/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all teams in an organization that are visible to the authenticated user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-teams", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List child teams", - "scope": "teams", - "id": "listChildInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the child teams of the team specified by `{team_slug}`.\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}/teams`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-child-teams", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if child teams exist", - "examples": [ - { - "data": "[{\"id\":2,\"node_id\":\"MDQ6VGVhbTI=\",\"url\":\"https://api.github.com/teams/2\",\"name\":\"Original Roster\",\"slug\":\"original-roster\",\"description\":\"Started it all.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/2/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/2/repos\",\"parent\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"},\"html_url\":\"https://github.com/orgs/rails/teams/core\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List child teams (Legacy)", - "scope": "teams", - "id": "listChildLegacy", - "method": "GET", - "url": "/teams/{team_id}/teams", - "isDeprecated": true, - "deprecationDate": "2020-01-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 child teams`](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-child-teams) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#list-child-teams-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if child teams exist", - "examples": [ - { - "data": "[{\"id\":2,\"node_id\":\"MDQ6VGVhbTI=\",\"url\":\"https://api.github.com/teams/2\",\"name\":\"Original Roster\",\"slug\":\"original-roster\",\"description\":\"Started it all.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/2/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/2/repos\",\"parent\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"},\"html_url\":\"https://github.com/orgs/rails/teams/core\"}]" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "List discussion comments", - "scope": "teams", - "id": "listDiscussionCommentsInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-discussion-comments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List discussion comments (Legacy)", - "scope": "teams", - "id": "listDiscussionCommentsLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "isDeprecated": true, - "deprecationDate": "2020-01-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 discussion comments](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-discussion-comments) endpoint.\n\nList all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-discussion-comments-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List discussions", - "scope": "teams", - "id": "listDiscussionsInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-discussions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pinned", - "description": "Pinned discussions only filter", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List discussions (Legacy)", - "scope": "teams", - "id": "listDiscussionsLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions", - "isDeprecated": true, - "deprecationDate": "2020-01-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 discussions`](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-discussions) endpoint.\n\nList all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-discussions-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List teams for the authenticated user", - "scope": "teams", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/teams", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-teams-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"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\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List team members", - "scope": "teams", - "id": "listMembersInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/members", - "isDeprecated": false, - "deprecationDate": null, - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-team-members", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["member", "maintainer", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List team members (Legacy)", - "scope": "teams", - "id": "listMembersLegacy", - "method": "GET", - "url": "/teams/{team_id}/members", - "isDeprecated": true, - "deprecationDate": "2020-01-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 team members`](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-team-members-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["member", "maintainer", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List team projects", - "scope": "teams", - "id": "listProjectsInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the organization projects for a team.\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}/projects`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-team-projects", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List team projects (Legacy)", - "scope": "teams", - "id": "listProjectsLegacy", - "method": "GET", - "url": "/teams/{team_id}/projects", - "isDeprecated": true, - "deprecationDate": "2020-01-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 team projects`](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#list-team-projects-legacy", - "previews": [{ "name": "inertia" }], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "List team repositories", - "scope": "teams", - "id": "listReposInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists a team's repositories visible to the authenticated user.\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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-team-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List team repositories (Legacy)", - "scope": "teams", - "id": "listReposLegacy", - "method": "GET", - "url": "/teams/{team_id}/repos", - "isDeprecated": true, - "deprecationDate": "2020-01-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 team repositories](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#list-team-repositories) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#list-team-repositories-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove team member (Legacy)", - "scope": "teams", - "id": "removeMemberLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-21", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#remove-team-member-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "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 }, - { - "code": 404, - "description": "Not Found if team synchronization is setup", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove team membership for a user", - "scope": "teams", - "id": "removeMembershipForUserInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#remove-team-membership-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "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 }, - { - "code": 403, - "description": "Forbidden if team synchronization is set up", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove team membership for a user (Legacy)", - "scope": "teams", - "id": "removeMembershipForUserLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Remove team membership for a user](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#remove-team-membership-for-a-user-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "", - "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 }, - { - "code": 403, - "description": "if team synchronization is set up", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove a project from a team", - "scope": "teams", - "id": "removeProjectInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\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}/projects/{project_id}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#remove-a-project-from-a-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "project_id", - "description": "", - "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": "Remove a project from a team (Legacy)", - "scope": "teams", - "id": "removeProjectLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Remove a project from a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#remove-a-project-from-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "project_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove a repository from a team", - "scope": "teams", - "id": "removeRepoInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\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}/repos/{owner}/{repo}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#remove-a-repository-from-a-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove a repository from a team (Legacy)", - "scope": "teams", - "id": "removeRepoLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Remove a repository from a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#remove-a-repository-from-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Update a discussion comment", - "scope": "teams", - "id": "updateDiscussionCommentInOrg", - "method": "PATCH", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.0/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#update-a-discussion-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like pineapples?\",\"body_html\":\"

Do you like pineapples?

\",\"body_version\":\"e6907b24d9c93cc0c5024a7af5888116\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a discussion comment (Legacy)", - "scope": "teams", - "id": "updateDiscussionCommentLegacy", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Update a discussion comment](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#update-a-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like pineapples?\",\"body_html\":\"

Do you like pineapples?

\",\"body_version\":\"e6907b24d9c93cc0c5024a7af5888116\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a discussion", - "scope": "teams", - "id": "updateDiscussionInOrg", - "method": "PATCH", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#update-a-discussion", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion post's body text.", - "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": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":1,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Welcome to our first team post\",\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a discussion (Legacy)", - "scope": "teams", - "id": "updateDiscussionLegacy", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Update a discussion](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#update-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion post's body text.", - "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": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":1,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Welcome to our first team post\",\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a team", - "scope": "teams", - "id": "updateInOrg", - "method": "PATCH", - "url": "/orgs/{org}/teams/{team_slug}", - "isDeprecated": false, - "deprecationDate": null, - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams#update-a-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["secret", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a team (Legacy)", - "scope": "teams", - "id": "updateLegacy", - "method": "PATCH", - "url": "/teams/{team_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Update a team](https://docs.github.com/enterprise-server@3.0/rest/reference/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/teams/#update-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "", - "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 team.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["secret", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Add an email address for the authenticated user", - "scope": "users", - "id": "addEmailForAuthenticated", - "method": "POST", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint is accessible with the `user` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#add-an-email-address-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "emails", - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@octocat.org\",\"primary\":false,\"verified\":false,\"visibility\":\"public\"},{\"email\":\"octocat@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null},{\"email\":\"mona@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Check if a user follows another user", - "scope": "users", - "id": "checkFollowingForUser", - "method": "GET", - "url": "/users/{username}/following/{target_user}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#check-if-a-user-follows-another-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_user", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "if the user follows the target user", - "examples": null - }, - { - "code": 404, - "description": "if the user does not follow the target user", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check if a person is followed by the authenticated user", - "scope": "users", - "id": "checkPersonIsFollowedByAuthenticated", - "method": "GET", - "url": "/user/following/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "if the person is followed by the authenticated user", - "examples": null - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "if the person is not followed by the authenticated user", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a GPG key for the authenticated user", - "scope": "users", - "id": "createGpgKeyForAuthenticated", - "method": "POST", - "url": "/user/gpg_keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#create-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "armored_public_key", - "description": "A GPG key in ASCII-armored format.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a public SSH key for the authenticated user", - "scope": "users", - "id": "createPublicSshKeyForAuthenticated", - "method": "POST", - "url": "/user/keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "title", - "description": "A descriptive name for the new key.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key", - "description": "The public SSH key to add to your GitHub account.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an email address for the authenticated user", - "scope": "users", - "id": "deleteEmailForAuthenticated", - "method": "DELETE", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint is accessible with the `user` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-an-email-address-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "emails", - "description": "Email addresses associated with the GitHub user account.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a GPG key for the authenticated user", - "scope": "users", - "id": "deleteGpgKeyForAuthenticated", - "method": "DELETE", - "url": "/user/gpg_keys/{gpg_key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gpg_key_id", - "description": "gpg_key_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a public SSH key for the authenticated user", - "scope": "users", - "id": "deletePublicSshKeyForAuthenticated", - "method": "DELETE", - "url": "/user/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_id", - "description": "key_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Follow a user", - "scope": "users", - "id": "follow", - "method": "PUT", - "url": "/user/following/{username}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#follow-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "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 }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the authenticated user", - "scope": "users", - "id": "getAuthenticated", - "method": "GET", - "url": "/user", - "isDeprecated": false, - "deprecationDate": null, - "description": "If the authenticated user is authenticated through basic authentication or OAuth 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"private_gists\":81,\"total_private_repos\":100,\"owned_private_repos\":100,\"disk_usage\":10000,\"collaborators\":8,\"two_factor_authentication\":true,\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"collaborators\":0}}" - }, - { - "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,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a user", - "scope": "users", - "id": "getByUsername", - "method": "GET", - "url": "/users/{username}", - "isDeprecated": false, - "deprecationDate": 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 Enterprise Server plan. The GitHub App must be authenticated as a user. See \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/enterprise-server@3.0/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [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 Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.0/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/enterprise-server@3.0/rest/reference/users#emails)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"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\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"twitter_username\":\"monatheoctocat\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\"}" - }, - { - "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,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"twitter_username\":\"monatheoctocat\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"plan\":{\"name\":\"pro\",\"space\":976562499,\"collaborators\":0,\"private_repos\":9999}}" - } - ] - }, - { "code": 202, "description": "Accepted", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get contextual information for a user", - "scope": "users", - "id": "getContextForUser", - "method": "GET", - "url": "/users/{username}/hovercard", - "isDeprecated": false, - "deprecationDate": 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```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-contextual-information-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "subject_type", - "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["organization", "repository", "issue", "pull_request"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "subject_id", - "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"contexts\":[{\"message\":\"Owns this repository\",\"octicon\":\"repo\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a GPG key for the authenticated user", - "scope": "users", - "id": "getGpgKeyForAuthenticated", - "method": "GET", - "url": "/user/gpg_keys/{gpg_key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gpg_key_id", - "description": "gpg_key_id parameter", - "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\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a public SSH key for the authenticated user", - "scope": "users", - "id": "getPublicSshKeyForAuthenticated", - "method": "GET", - "url": "/user/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_id", - "description": "key_id parameter", - "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": "{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List users", - "scope": "users", - "id": "list", - "method": "GET", - "url": "/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-users", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "A user ID. Only return users with an ID greater than this ID.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "List email addresses for the authenticated user", - "scope": "users", - "id": "listEmailsForAuthenticated", - "method": "GET", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-email-addresses-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List the people the authenticated user follows", - "scope": "users", - "id": "listFollowedByAuthenticated", - "method": "GET", - "url": "/user/following", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people who the authenticated user follows.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-the-people-the-authenticated-user-follows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List followers of the authenticated user", - "scope": "users", - "id": "listFollowersForAuthenticatedUser", - "method": "GET", - "url": "/user/followers", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people following the authenticated user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-followers-of-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List followers of a user", - "scope": "users", - "id": "listFollowersForUser", - "method": "GET", - "url": "/users/{username}/followers", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people following the specified user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-followers-of-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List the people a user follows", - "scope": "users", - "id": "listFollowingForUser", - "method": "GET", - "url": "/users/{username}/following", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people who the specified user follows.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-the-people-a-user-follows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List GPG keys for the authenticated user", - "scope": "users", - "id": "listGpgKeysForAuthenticated", - "method": "GET", - "url": "/user/gpg_keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-gpg-keys-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"string\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List GPG keys for a user", - "scope": "users", - "id": "listGpgKeysForUser", - "method": "GET", - "url": "/users/{username}/gpg_keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the GPG keys for a user. This information is accessible by anyone.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-gpg-keys-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"string\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public email addresses for the authenticated user", - "scope": "users", - "id": "listPublicEmailsForAuthenticated", - "method": "GET", - "url": "/user/public_emails", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-email-addresses-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List public keys for a user", - "scope": "users", - "id": "listPublicKeysForUser", - "method": "GET", - "url": "/users/{username}/keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-keys-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "[{\"id\":1,\"key\":\"ssh-rsa AAA...\"}]" }] - } - ], - "renamed": null - }, - { - "name": "List public SSH keys for the authenticated user", - "scope": "users", - "id": "listPublicSshKeysForAuthenticated", - "method": "GET", - "url": "/user/keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false},{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234\",\"id\":3,\"url\":\"https://api.github.com/user/keys/3\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAB\",\"created_at\":\"2020-07-11T21:31:57Z\",\"verified\":false,\"read_only\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unfollow a user", - "scope": "users", - "id": "unfollow", - "method": "DELETE", - "url": "/user/following/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#unfollow-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "", - "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 }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update the authenticated user", - "scope": "users", - "id": "updateAuthenticated", - "method": "PATCH", - "url": "/user", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.0/rest/reference/users/#update-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "The new name of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "email", - "description": "The publicly visible email address of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "blog", - "description": "The new blog URL of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "twitter_username", - "description": "The new Twitter username of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "company", - "description": "The new company of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "location", - "description": "The new location of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hireable", - "description": "The new hiring availability of the user.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "bio", - "description": "The new short biography of the user.", - "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": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"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\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"private_gists\":81,\"total_private_repos\":100,\"owned_private_repos\":100,\"disk_usage\":10000,\"collaborators\":8,\"two_factor_authentication\":true,\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"collaborators\":0}}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - } -] diff --git a/scripts/update-endpoints/generated/ghe32-endpoints.json b/scripts/update-endpoints/generated/ghe32-endpoints.json deleted file mode 100644 index 5775abc3..00000000 --- a/scripts/update-endpoints/generated/ghe32-endpoints.json +++ /dev/null @@ -1,53408 +0,0 @@ -[ - { - "name": "Add selected repository to an organization secret", - "scope": "actions", - "id": "addSelectedRepoToOrgSecret", - "method": "PUT", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#add-selected-repository-to-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "No Content when repository was added to the selected list", - "examples": null - }, - { - "code": 409, - "description": "Conflict when visibility type is not set to selected", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Cancel a workflow run", - "scope": "actions", - "id": "cancelWorkflowRun", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", - "isDeprecated": false, - "deprecationDate": null, - "description": "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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#cancel-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [{ "data": "null" }] - }, - { "code": 409, "description": "Conflict", "examples": null } - ], - "renamed": null - }, - { - "name": "Create or update an environment secret", - "scope": "actions", - "id": "createOrUpdateEnvironmentSecret", - "method": "PUT", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#create-or-update-an-environment-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "encrypted_value", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-an-environment-public-key) endpoint.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "ID of the key you used to encrypt the secret.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response when creating a secret", - "examples": [{ "data": "null" }] - }, - { - "code": 204, - "description": "Response when updating a secret", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create or update an organization secret", - "scope": "actions", - "id": "createOrUpdateOrgSecret", - "method": "PUT", - "url": "/orgs/{org}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#create-or-update-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "encrypted_value", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-an-organization-public-key) endpoint.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "ID of the key you used to encrypt the secret.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["all", "private", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "in": "BODY", - "type": "integer[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response when creating a secret", - "examples": [{ "data": "null" }] - }, - { - "code": 204, - "description": "Response when updating a secret", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create or update a repository secret", - "scope": "actions", - "id": "createOrUpdateRepoSecret", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#create-or-update-a-repository-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "encrypted_value", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-a-repository-public-key) endpoint.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "ID of the key you used to encrypt the secret.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response when creating a secret", - "examples": [{ "data": "null" }] - }, - { - "code": 204, - "description": "Response when updating a secret", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a registration token for an organization", - "scope": "actions", - "id": "createRegistrationTokenForOrg", - "method": "POST", - "url": "/orgs/{org}/actions/runners/registration-token", - "isDeprecated": false, - "deprecationDate": 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.\n\n#### Example 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```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#create-a-registration-token-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": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"LLBF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-22T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a registration token for a repository", - "scope": "actions", - "id": "createRegistrationTokenForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runners/registration-token", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate\nusing an access token with the `repo` scope to use this endpoint.\n\n#### Example 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/octo-repo-artifacts --token TOKEN\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#create-a-registration-token-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"LLBF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-22T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a remove token for an organization", - "scope": "actions", - "id": "createRemoveTokenForOrg", - "method": "POST", - "url": "/orgs/{org}/actions/runners/remove-token", - "isDeprecated": false, - "deprecationDate": 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.\n\n#### Example 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```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#create-a-remove-token-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": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"AABF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-29T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a remove token for a repository", - "scope": "actions", - "id": "createRemoveTokenForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runners/remove-token", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\n\n#### Example using remove token\n \nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.\n\n```\n./config.sh remove --token TOKEN\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#create-a-remove-token-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"AABF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-29T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a workflow dispatch event", - "scope": "actions", - "id": "createWorkflowDispatch", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", - "isDeprecated": false, - "deprecationDate": 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).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#create-a-workflow-dispatch-event", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The git reference for the workflow. The reference can be a branch or tag name.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "inputs", - "description": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "inputs.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an artifact", - "scope": "actions", - "id": "deleteArtifact", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#delete-an-artifact", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "artifact_id", - "description": "The unique identifier of the artifact.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an environment secret", - "scope": "actions", - "id": "deleteEnvironmentSecret", - "method": "DELETE", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#delete-an-environment-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Default response", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an organization secret", - "scope": "actions", - "id": "deleteOrgSecret", - "method": "DELETE", - "url": "/orgs/{org}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": 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 `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#delete-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a repository secret", - "scope": "actions", - "id": "deleteRepoSecret", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": 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 `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#delete-a-repository-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a self-hosted runner from an organization", - "scope": "actions", - "id": "deleteSelfHostedRunnerFromOrg", - "method": "DELETE", - "url": "/orgs/{org}/actions/runners/{runner_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a self-hosted runner from a repository", - "scope": "actions", - "id": "deleteSelfHostedRunnerFromRepo", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "isDeprecated": false, - "deprecationDate": 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`\nscope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a workflow run", - "scope": "actions", - "id": "deleteWorkflowRun", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#delete-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete workflow run logs", - "scope": "actions", - "id": "deleteWorkflowRunLogs", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#delete-workflow-run-logs", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "Disable a selected repository for GitHub Actions in an organization", - "scope": "actions", - "id": "disableSelectedRepositoryGithubActionsOrganization", - "method": "DELETE", - "url": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Disable a workflow", - "scope": "actions", - "id": "disableWorkflow", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#disable-a-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Download an artifact", - "scope": "actions", - "id": "downloadArtifact", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", - "isDeprecated": false, - "deprecationDate": 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`. 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#download-an-artifact", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "artifact_id", - "description": "The unique identifier of the artifact.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "archive_format", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 302, "description": "Response", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Download job logs for a workflow run", - "scope": "actions", - "id": "downloadJobLogsForWorkflowRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#download-job-logs-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. 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": "job_id", - "description": "The unique identifier of the job.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Download workflow run logs", - "scope": "actions", - "id": "downloadWorkflowRunLogs", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#download-workflow-run-logs", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Enable a selected repository for GitHub Actions in an organization", - "scope": "actions", - "id": "enableSelectedRepositoryGithubActionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Enable a workflow", - "scope": "actions", - "id": "enableWorkflow", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#enable-a-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get allowed actions for an organization", - "scope": "actions", - "id": "getAllowedActionsOrganization", - "method": "GET", - "url": "/orgs/{org}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-allowed-actions-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": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get allowed actions for a repository", - "scope": "actions", - "id": "getAllowedActionsRepository", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-allowed-actions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an artifact", - "scope": "actions", - "id": "getArtifact", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-an-artifact", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "artifact_id", - "description": "The unique identifier of the artifact.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-01-21T14:59:22Z\",\"updated_at\":\"2020-01-21T14:59:22Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an environment public key", - "scope": "actions", - "id": "getEnvironmentPublicKey", - "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-an-environment-public-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an environment secret", - "scope": "actions", - "id": "getEnvironmentSecret", - "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-an-environment-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get GitHub Actions permissions for an organization", - "scope": "actions", - "id": "getGithubActionsPermissionsOrganization", - "method": "GET", - "url": "/orgs/{org}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-github-actions-permissions-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"enabled_repositories\":\"all\",\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/organizations/42/actions/permissions/selected-actions\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get GitHub Actions permissions for a repository", - "scope": "actions", - "id": "getGithubActionsPermissionsRepository", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-github-actions-permissions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"enabled\":true,\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/repositories/42/actions/permissions/selected-actions\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a job for a workflow run", - "scope": "actions", - "id": "getJobForWorkflowRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-a-job-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. 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": "job_id", - "description": "The unique identifier of the job.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an organization public key", - "scope": "actions", - "id": "getOrgPublicKey", - "method": "GET", - "url": "/orgs/{org}/actions/secrets/public-key", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-an-organization-public-key", - "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": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an organization secret", - "scope": "actions", - "id": "getOrgSecret", - "method": "GET", - "url": "/orgs/{org}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get pending deployments for a workflow run", - "scope": "actions", - "id": "getPendingDeploymentsForRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-pending-deployments-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"environment\":{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\"},\"wait_timer\":30,\"wait_timer_started_at\":\"2020-11-23T22:00:40Z\",\"current_user_can_approve\":true,\"reviewers\":[{\"type\":\"User\",\"reviewer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}},{\"type\":\"Team\",\"reviewer\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository public key", - "scope": "actions", - "id": "getRepoPublicKey", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets/public-key", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-a-repository-public-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository secret", - "scope": "actions", - "id": "getRepoSecret", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-a-repository-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the review history for a workflow run", - "scope": "actions", - "id": "getReviewsForRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", - "isDeprecated": false, - "deprecationDate": null, - "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-the-review-history-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"state\":\"approved\",\"comment\":\"Ship it!\",\"environments\":[{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\"}],\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a self-hosted runner for an organization", - "scope": "actions", - "id": "getSelfHostedRunnerForOrg", - "method": "GET", - "url": "/orgs/{org}/actions/runners/{runner_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-a-self-hosted-runner-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a self-hosted runner for a repository", - "scope": "actions", - "id": "getSelfHostedRunnerForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-a-self-hosted-runner-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a workflow", - "scope": "actions", - "id": "getWorkflow", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-a-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a workflow run", - "scope": "actions", - "id": "getWorkflowRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"main\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"path\":\".github/workflows/build.yml@main\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List artifacts for a repository", - "scope": "actions", - "id": "listArtifactsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-artifacts-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"Test output\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List environment secrets", - "scope": "actions", - "id": "listEnvironmentSecrets", - "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-environment-secrets", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List jobs for a workflow run", - "scope": "actions", - "id": "listJobsForWorkflowRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#parameters).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-jobs-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["latest", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organization secrets", - "scope": "actions", - "id": "listOrgSecrets", - "method": "GET", - "url": "/orgs/{org}/actions/secrets", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-organization-secrets", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":3,\"secrets\":[{\"name\":\"GIST_ID\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"DEPLOY_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository secrets", - "scope": "actions", - "id": "listRepoSecrets", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-repository-secrets", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository workflows", - "scope": "actions", - "id": "listRepoWorkflows", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-repository-workflows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"},{\"id\":269289,\"node_id\":\"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\"name\":\"Linter\",\"path\":\".github/workflows/linter.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List runner applications for an organization", - "scope": "actions", - "id": "listRunnerApplicationsForOrg", - "method": "GET", - "url": "/orgs/{org}/actions/runners/downloads", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-runner-applications-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw\",\"sha256_checksum\":\"2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip\",\"filename\":\"actions-runner-win-x64-2.277.1.zip\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List runner applications for a repository", - "scope": "actions", - "id": "listRunnerApplicationsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners/downloads", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-runner-applications-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw\",\"sha256_checksum\":\"2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip\",\"filename\":\"actions-runner-win-x64-2.277.1.zip\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List selected repositories for an organization secret", - "scope": "actions", - "id": "listSelectedReposForOrgSecret", - "method": "GET", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-selected-repositories-for-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List selected repositories enabled for GitHub Actions in an organization", - "scope": "actions", - "id": "listSelectedRepositoriesEnabledGithubActionsOrganization", - "method": "GET", - "url": "/orgs/{org}/actions/permissions/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List self-hosted runners for an organization", - "scope": "actions", - "id": "listSelfHostedRunnersForOrg", - "method": "GET", - "url": "/orgs/{org}/actions/runners", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all self-hosted runners configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-self-hosted-runners-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List self-hosted runners for a repository", - "scope": "actions", - "id": "listSelfHostedRunnersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-self-hosted-runners-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List workflow run artifacts", - "scope": "actions", - "id": "listWorkflowRunArtifacts", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-workflow-run-artifacts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"Test output\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List workflow runs for a workflow", - "scope": "actions", - "id": "listWorkflowRuns", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-workflow-runs", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actor", - "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "completed", - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "in_progress", - "queued", - "requested", - "waiting" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "created", - "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.2/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List workflow runs for a repository", - "scope": "actions", - "id": "listWorkflowRunsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-workflow-runs-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actor", - "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "completed", - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "in_progress", - "queued", - "requested", - "waiting" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "created", - "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.2/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Re-run a workflow", - "scope": "actions", - "id": "reRunWorkflow", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", - "isDeprecated": false, - "deprecationDate": null, - "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#re-run-a-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [{ "data": "null" }] - } - ], - "renamed": null - }, - { - "name": "Remove selected repository from an organization secret", - "scope": "actions", - "id": "removeSelectedRepoFromOrgSecret", - "method": "DELETE", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#remove-selected-repository-from-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response when repository was removed from the selected list", - "examples": null - }, - { - "code": 409, - "description": "Conflict when visibility type not set to selected", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Review pending deployments for a workflow run", - "scope": "actions", - "id": "reviewPendingDeploymentsForRun", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#review-pending-deployments-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_ids", - "description": "The list of environment ids to approve or reject", - "in": "BODY", - "type": "integer[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Whether to approve or reject deployment to the specified environments.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["approved", "rejected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment", - "description": "A comment to accompany the deployment review", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set allowed actions for an organization", - "scope": "actions", - "id": "setAllowedActionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-allowed-actions-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "github_owned_allowed", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "patterns_allowed", - "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "in": "BODY", - "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": "Set allowed actions for a repository", - "scope": "actions", - "id": "setAllowedActionsRepository", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-allowed-actions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "github_owned_allowed", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "patterns_allowed", - "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "in": "BODY", - "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": "Set GitHub Actions permissions for an organization", - "scope": "actions", - "id": "setGithubActionsPermissionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-github-actions-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 - }, - { - "name": "enabled_repositories", - "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["all", "none", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allowed_actions", - "description": "The permissions policy that controls the actions that are allowed to run.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "local_only", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Set GitHub Actions permissions for a repository", - "scope": "actions", - "id": "setGithubActionsPermissionsRepository", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-github-actions-permissions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enabled", - "description": "Whether GitHub Actions is enabled on the repository.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allowed_actions", - "description": "The permissions policy that controls the actions that are allowed to run.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "local_only", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Set selected repositories for an organization secret", - "scope": "actions", - "id": "setSelectedReposForOrgSecret", - "method": "PUT", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-selected-repositories-for-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.2/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "in": "BODY", - "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 selected repositories enabled for GitHub Actions in an organization", - "scope": "actions", - "id": "setSelectedRepositoriesEnabledGithubActionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "description": "List of repository IDs to enable for GitHub Actions.", - "in": "BODY", - "type": "integer[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Check if a repository is starred by the authenticated user", - "scope": "activity", - "id": "checkRepoIsStarredByAuthenticatedUser", - "method": "GET", - "url": "/user/starred/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if this repository is starred by you", - "examples": null - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if this repository is not starred by you", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a repository subscription", - "scope": "activity", - "id": "deleteRepoSubscription", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#set-a-repository-subscription).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#delete-a-repository-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a thread subscription", - "scope": "activity", - "id": "deleteThreadSubscription", - "method": "DELETE", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#delete-a-thread-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "The unique identifier of the pull request thread.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get feeds", - "scope": "activity", - "id": "getFeeds", - "method": "GET", - "url": "/feeds", - "isDeprecated": false, - "deprecationDate": null, - "description": "GitHub Enterprise Server 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 Enterprise Server global public timeline\n* **User**: The public timeline for any user, using [URI template](https://docs.github.com/enterprise-server@3.2/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 Enterprise Server.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#get-feeds", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"timeline_url\":\"https://github.com/timeline\",\"user_url\":\"https://github.com/{user}\",\"current_user_public_url\":\"https://github.com/octocat\",\"current_user_url\":\"https://github.com/octocat.private?token=abc123\",\"current_user_actor_url\":\"https://github.com/octocat.private.actor?token=abc123\",\"current_user_organization_url\":\"\",\"current_user_organization_urls\":[\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"],\"security_advisories_url\":\"https://github.com/security-advisories\",\"_links\":{\"timeline\":{\"href\":\"https://github.com/timeline\",\"type\":\"application/atom+xml\"},\"user\":{\"href\":\"https://github.com/{user}\",\"type\":\"application/atom+xml\"},\"current_user_public\":{\"href\":\"https://github.com/octocat\",\"type\":\"application/atom+xml\"},\"current_user\":{\"href\":\"https://github.com/octocat.private?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_actor\":{\"href\":\"https://github.com/octocat.private.actor?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_organization\":{\"href\":\"\",\"type\":\"\"},\"current_user_organizations\":[{\"href\":\"https://github.com/organizations/github/octocat.private.atom?token=abc123\",\"type\":\"application/atom+xml\"}]}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository subscription", - "scope": "activity", - "id": "getRepoSubscription", - "method": "GET", - "url": "/repos/{owner}/{repo}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#get-a-repository-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if you subscribe to the repository", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if you don't subscribe to the repository", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a thread", - "scope": "activity", - "id": "getThread", - "method": "GET", - "url": "/notifications/threads/{thread_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#get-a-thread", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "The unique identifier of the pull request thread.", - "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\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a thread subscription for the authenticated user", - "scope": "activity", - "id": "getThreadSubscriptionForAuthenticatedUser", - "method": "GET", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "The unique identifier of the pull request thread.", - "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": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List events for the authenticated user", - "scope": "activity", - "id": "listEventsForAuthenticatedUser", - "method": "GET", - "url": "/users/{username}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-events-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084947\",\"type\":\"WatchEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"action\":\"started\"},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":false,\"created_at\":\"2022-06-07T07:50:26Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List notifications for the authenticated user", - "scope": "activity", - "id": "listNotificationsForAuthenticatedUser", - "method": "GET", - "url": "/notifications", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all notifications for the current user, sorted by most recently updated.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "all", - "description": "If `true`, show notifications marked as read.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "participating", - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 50).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List organization events for the authenticated user", - "scope": "activity", - "id": "listOrgEventsForAuthenticatedUser", - "method": "GET", - "url": "/users/{username}/events/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-organization-events-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":false,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22196946742\",\"type\":\"CreateEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"ref\":null,\"ref_type\":\"repository\",\"master_branch\":\"master\",\"description\":null,\"pusher_type\":\"user\"},\"public\":false,\"created_at\":\"2022-06-07T07:50:26Z\",\"org\":{\"id\":9919,\"login\":\"github\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?\"}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public events", - "scope": "activity", - "id": "listPublicEvents", - "method": "GET", - "url": "/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-public-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084947\",\"type\":\"WatchEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"action\":\"started\"},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-07T07:50:26Z\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List public events for a network of repositories", - "scope": "activity", - "id": "listPublicEventsForRepoNetwork", - "method": "GET", - "url": "/networks/{owner}/{repo}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-public-events-for-a-network-of-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22237752260\",\"type\":\"WatchEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/rrubenich\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"action\":\"started\"},\"public\":true,\"created_at\":\"2022-06-08T23:29:25Z\"}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List public events for a user", - "scope": "activity", - "id": "listPublicEventsForUser", - "method": "GET", - "url": "/users/{username}/events/public", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-public-events-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084947\",\"type\":\"WatchEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"action\":\"started\"},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-08T23:29:25Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public organization events", - "scope": "activity", - "id": "listPublicOrgEvents", - "method": "GET", - "url": "/orgs/{org}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-public-organization-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22237752260\",\"type\":\"WatchEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octo-org/octo-repo\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo\"},\"payload\":{\"action\":\"started\"},\"public\":true,\"created_at\":\"2022-06-08T23:29:25Z\"},{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octo-org/octo-repo\",\"url\":\"https://api.github.com/repos/octo-org/oct-repo\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List events received by the authenticated user", - "scope": "activity", - "id": "listReceivedEventsForUser", - "method": "GET", - "url": "/users/{username}/received_events", - "isDeprecated": false, - "deprecationDate": null, - "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-events-received-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22196946742\",\"type\":\"CreateEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"ref\":null,\"ref_type\":\"repository\",\"master_branch\":\"master\",\"description\":null,\"pusher_type\":\"user\"},\"public\":false,\"created_at\":\"2022-06-07T07:50:26Z\",\"org\":{\"id\":9919,\"login\":\"github\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?\"}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public events received by a user", - "scope": "activity", - "id": "listReceivedPublicEventsForUser", - "method": "GET", - "url": "/users/{username}/received_events/public", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-public-events-received-by-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22196946742\",\"type\":\"CreateEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"ref\":null,\"ref_type\":\"repository\",\"master_branch\":\"master\",\"description\":null,\"pusher_type\":\"user\"},\"public\":false,\"created_at\":\"2022-06-07T07:50:26Z\",\"org\":{\"id\":9919,\"login\":\"github\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?\"}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository events", - "scope": "activity", - "id": "listRepoEvents", - "method": "GET", - "url": "/repos/{owner}/{repo}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repository-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22237752260\",\"type\":\"WatchEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"action\":\"started\"},\"public\":true,\"created_at\":\"2022-06-08T23:29:25Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository notifications for the authenticated user", - "scope": "activity", - "id": "listRepoNotificationsForAuthenticatedUser", - "method": "GET", - "url": "/repos/{owner}/{repo}/notifications", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all notifications for the current user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repository-notifications-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "all", - "description": "If `true`, show notifications marked as read.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "participating", - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories starred by the authenticated user", - "scope": "activity", - "id": "listReposStarredByAuthenticatedUser", - "method": "GET", - "url": "/user/starred", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repositories-starred-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "sort", - "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" - } - ] - }, - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List repositories starred by a user", - "scope": "activity", - "id": "listReposStarredByUser", - "method": "GET", - "url": "/users/{username}/starred", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repositories-starred-by-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories watched by a user", - "scope": "activity", - "id": "listReposWatchedByUser", - "method": "GET", - "url": "/users/{username}/subscriptions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists repositories a user is watching.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repositories-watched-by-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List stargazers", - "scope": "activity", - "id": "listStargazersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/stargazers", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-stargazers", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - }, - { - "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List repositories watched by the authenticated user", - "scope": "activity", - "id": "listWatchedReposForAuthenticatedUser", - "method": "GET", - "url": "/user/subscriptions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists repositories the authenticated user is watching.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repositories-watched-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List watchers", - "scope": "activity", - "id": "listWatchersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/subscribers", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people watching the specified repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-watchers", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Mark notifications as read", - "scope": "activity", - "id": "markNotificationsAsRead", - "method": "PUT", - "url": "/notifications", - "isDeprecated": false, - "deprecationDate": null, - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#mark-notifications-as-read", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "last_read_at", - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "read", - "description": "Whether the notification has been read.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"message\":\"Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background.\"}" - } - ] - }, - { "code": 205, "description": "Reset Content", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Mark repository notifications as read", - "scope": "activity", - "id": "markRepoNotificationsAsRead", - "method": "PUT", - "url": "/repos/{owner}/{repo}/notifications", - "isDeprecated": false, - "deprecationDate": null, - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#mark-repository-notifications-as-read", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "last_read_at", - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Response", "examples": null }, - { "code": 205, "description": "Reset Content", "examples": null } - ], - "renamed": null - }, - { - "name": "Mark a thread as read", - "scope": "activity", - "id": "markThreadAsRead", - "method": "PATCH", - "url": "/notifications/threads/{thread_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#mark-a-thread-as-read", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "The unique identifier of the pull request thread.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 205, "description": "Reset Content", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Set a repository subscription", - "scope": "activity", - "id": "setRepoSubscription", - "method": "PUT", - "url": "/repos/{owner}/{repo}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#delete-a-repository-subscription) completely.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#set-a-repository-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "subscribed", - "description": "Determines if notifications should be received from this repository.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ignored", - "description": "Determines if all notifications should be blocked from this repository.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set a thread subscription", - "scope": "activity", - "id": "setThreadSubscription", - "method": "PUT", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.2/rest/reference/activity#delete-a-thread-subscription) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#set-a-thread-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "The unique identifier of the pull request thread.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ignored", - "description": "Whether to block all notifications from a thread.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Star a repository for the authenticated user", - "scope": "activity", - "id": "starRepoForAuthenticatedUser", - "method": "PUT", - "url": "/user/starred/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#star-a-repository-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unstar a repository for the authenticated user", - "scope": "activity", - "id": "unstarRepoForAuthenticatedUser", - "method": "DELETE", - "url": "/user/starred/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/activity#unstar-a-repository-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Add a repository to an app installation", - "scope": "apps", - "id": "addRepoToInstallation", - "method": "PUT", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.2/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#add-a-repository-to-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "apps", "id": "addRepoToInstallation" }, - "after": { - "scope": "apps", - "id": "addRepoToInstallationForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Add a repository to an app installation", - "scope": "apps", - "id": "addRepoToInstallationForAuthenticatedUser", - "method": "PUT", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.2/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#add-a-repository-to-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Check an authorization", - "scope": "apps", - "id": "checkAuthorization", - "method": "GET", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#check-an-authorization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Check a token", - "scope": "apps", - "id": "checkToken", - "method": "POST", - "url": "/applications/{client_id}/token", - "isDeprecated": false, - "deprecationDate": null, - "description": "OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#check-a-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The access_token of the OAuth application.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a content attachment", - "scope": "apps", - "id": "createContentAttachment", - "method": "POST", - "url": "/content_references/{content_reference_id}/attachments", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Deprecated:** use `apps.createContentAttachmentForRepo()` (`POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments`) instead. Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-content-attachment", - "previews": [{ "name": "corsair" }], - "headers": [], - "parameters": [ - { - "name": "content_reference_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":101,\"title\":\"[A-1234] Error found in core/models.py file'\",\"body\":\"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a content attachment", - "scope": "apps", - "id": "createContentAttachmentForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.2/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#create-a-content-attachment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "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. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":101,\"title\":\"[A-1234] Error found in core/models.py file'\",\"body\":\"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a GitHub App from a manifest", - "scope": "apps", - "id": "createFromManifest", - "method": "POST", - "url": "/app-manifests/{code}/conversions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#create-a-github-app-from-a-manifest", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "code", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDxOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"],\"client_id\":\"Iv1.8a61f9b3a7aba766\",\"client_secret\":\"1726be1638095a19edd134c77bde3aa2ece1e5d8\",\"webhook_secret\":\"e340154128314309424b7c8e90325147d99fdafa\",\"pem\":\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\\n-----END RSA PRIVATE KEY-----\\n\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create an installation access token for an app", - "scope": "apps", - "id": "createInstallationAccessToken", - "method": "POST", - "url": "/app/installations/{installation_id}/access_tokens", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps/#create-an-installation-access-token-for-an-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repositories", - "description": "List of repository names that the token should have access to", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_ids", - "description": "List of repository IDs that the token should have access to", - "in": "BODY", - "type": "integer[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions", - "description": "The permissions granted to the user-to-server access token.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.actions", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.administration", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.checks", - "description": "The level of permission to grant the access token for checks on code.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.contents", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.deployments", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.environments", - "description": "The level of permission to grant the access token for managing repository environments.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.issues", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.metadata", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.packages", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.pages", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.pull_requests", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.repository_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.repository_projects", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.secret_scanning_alerts", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.secrets", - "description": "The level of permission to grant the access token to manage repository secrets.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.security_events", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.single_file", - "description": "The level of permission to grant the access token to manage just a single file.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.statuses", - "description": "The level of permission to grant the access token for commit statuses.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.vulnerability_alerts", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.workflows", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.members", - "description": "The level of permission to grant the access token for organization teams and members.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_administration", - "description": "The level of permission to grant the access token to manage access to an organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_plan", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_projects", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_packages", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_secrets", - "description": "The level of permission to grant the access token to manage organization secrets.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_self_hosted_runners", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_user_blocking", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.team_discussions", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.content_references", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"ghs_16C7e42F292c6912E7710c838347Ae178B4a\",\"expires_at\":\"2016-07-11T22:14:10Z\",\"permissions\":{\"issues\":\"write\",\"contents\":\"read\"},\"repository_selection\":\"selected\",\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete an app authorization", - "scope": "apps", - "id": "deleteAuthorization", - "method": "DELETE", - "url": "/applications/{client_id}/grant", - "isDeprecated": false, - "deprecationDate": null, - "description": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#delete-an-app-authorization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The OAuth access token used to authenticate to the GitHub API.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete an installation for the authenticated app", - "scope": "apps", - "id": "deleteInstallation", - "method": "DELETE", - "url": "/app/installations/{installation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-server@3.2/rest/reference/apps/#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#delete-an-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an app token", - "scope": "apps", - "id": "deleteToken", - "method": "DELETE", - "url": "/applications/{client_id}/token", - "isDeprecated": false, - "deprecationDate": null, - "description": "OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#delete-an-app-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The OAuth access token used to authenticate to the GitHub API.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get the authenticated app", - "scope": "apps", - "id": "getAuthenticated", - "method": "GET", - "url": "/app", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.2/rest/reference/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#get-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an app", - "scope": "apps", - "id": "getBySlug", - "method": "GET", - "url": "/apps/{app_slug}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps/#get-an-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "app_slug", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an installation for the authenticated app", - "scope": "apps", - "id": "getInstallation", - "method": "GET", - "url": "/app/installations/{installation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#get-an-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"selected\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an organization installation for the authenticated app", - "scope": "apps", - "id": "getOrgInstallation", - "method": "GET", - "url": "/orgs/{org}/installation", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/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/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository installation for the authenticated app", - "scope": "apps", - "id": "getRepoInstallation", - "method": "GET", - "url": "/repos/{owner}/{repo}/installation", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/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/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a user installation for the authenticated app", - "scope": "apps", - "id": "getUserInstallation", - "method": "GET", - "url": "/users/{username}/installation", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#get-a-user-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/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/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a webhook configuration for an app", - "scope": "apps", - "id": "getWebhookConfigForApp", - "method": "GET", - "url": "/app/hook/config", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#get-a-webhook-configuration-for-an-app", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a delivery for an app webhook", - "scope": "apps", - "id": "getWebhookDelivery", - "method": "GET", - "url": "/app/hook/deliveries/{delivery_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#get-a-delivery-for-an-app-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "delivery_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"url\":\"https://www.example.com\",\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List repositories accessible to the user access token", - "scope": "apps", - "id": "listInstallationReposForAuthenticatedUser", - "method": "GET", - "url": "/user/installations/{installation_id}/repositories", - "isDeprecated": false, - "deprecationDate": 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-to-server OAuth access token](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#list-repositories-accessible-to-the-user-access-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The access the user has to each repository is included in the hash under the `permissions` key.", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List installations for the authenticated app", - "scope": "apps", - "id": "listInstallations", - "method": "GET", - "url": "/app/installations", - "isDeprecated": false, - "deprecationDate": null, - "description": "You must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#list-installations-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "outdated", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The permissions the installation has are included under the `permissions` key.", - "examples": [ - { - "data": "[{\"id\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"selected\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List app installations accessible to the user access token", - "scope": "apps", - "id": "listInstallationsForAuthenticatedUser", - "method": "GET", - "url": "/user/installations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "You can find the permissions for the installation under the `permissions` key.", - "examples": [ - { - "data": "{\"total_count\":2,\"installations\":[{\"id\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null},{\"id\":3,\"account\":{\"login\":\"octocat\",\"id\":2,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List repositories accessible to the app installation", - "scope": "apps", - "id": "listReposAccessibleToInstallation", - "method": "GET", - "url": "/installation/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "List repositories that an app installation can access.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#list-repositories-accessible-to-the-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List deliveries for an app webhook", - "scope": "apps", - "id": "listWebhookDeliveries", - "method": "GET", - "url": "/app/hook/deliveries", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#list-deliveries-for-an-app-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "cursor", - "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456},{\"id\":123456789,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-04T00:57:16Z\",\"redelivery\":true,\"duration\":0.28,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456}]" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Redeliver a delivery for an app webhook", - "scope": "apps", - "id": "redeliverWebhookDelivery", - "method": "POST", - "url": "/app/hook/deliveries/{delivery_id}/attempts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "delivery_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove a repository from an app installation", - "scope": "apps", - "id": "removeRepoFromInstallation", - "method": "DELETE", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.2/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#remove-a-repository-from-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "apps", "id": "removeRepoFromInstallation" }, - "after": { - "scope": "apps", - "id": "removeRepoFromInstallationForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Remove a repository from an app installation", - "scope": "apps", - "id": "removeRepoFromInstallationForAuthenticatedUser", - "method": "DELETE", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.2/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#remove-a-repository-from-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Reset an authorization", - "scope": "apps", - "id": "resetAuthorization", - "method": "POST", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#reset-an-authorization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Reset a token", - "scope": "apps", - "id": "resetToken", - "method": "PATCH", - "url": "/applications/{client_id}/token", - "isDeprecated": false, - "deprecationDate": null, - "description": "OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#reset-a-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The access_token of the OAuth application.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Revoke an authorization for an application", - "scope": "apps", - "id": "revokeAuthorizationForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#revoke-an-authorization-for-an-application", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "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": "Revoke a grant for an application", - "scope": "apps", - "id": "revokeGrantForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/grants/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub Enterprise Server](https://github.com/settings/applications#authorized).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#revoke-a-grant-for-an-application", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "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": "Revoke an installation access token", - "scope": "apps", - "id": "revokeInstallationAccessToken", - "method": "DELETE", - "url": "/installation/token", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/apps#create-an-installation-access-token-for-an-app)\" endpoint.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#revoke-an-installation-access-token", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Create a scoped access token", - "scope": "apps", - "id": "scopeToken", - "method": "POST", - "url": "/applications/{client_id}/token/scoped", - "isDeprecated": false, - "deprecationDate": null, - "description": "Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.2/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#create-a-scoped-access-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The OAuth access token used to authenticate to the GitHub API.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target", - "description": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_id", - "description": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repositories", - "description": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_ids", - "description": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", - "in": "BODY", - "type": "integer[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions", - "description": "The permissions granted to the user-to-server access token.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.actions", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.administration", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.checks", - "description": "The level of permission to grant the access token for checks on code.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.contents", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.deployments", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.environments", - "description": "The level of permission to grant the access token for managing repository environments.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.issues", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.metadata", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.packages", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.pages", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.pull_requests", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.repository_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.repository_projects", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.secret_scanning_alerts", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.secrets", - "description": "The level of permission to grant the access token to manage repository secrets.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.security_events", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.single_file", - "description": "The level of permission to grant the access token to manage just a single file.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.statuses", - "description": "The level of permission to grant the access token for commit statuses.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.vulnerability_alerts", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.workflows", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.members", - "description": "The level of permission to grant the access token for organization teams and members.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_administration", - "description": "The level of permission to grant the access token to manage access to an organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_plan", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_projects", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_packages", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_secrets", - "description": "The level of permission to grant the access token to manage organization secrets.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_self_hosted_runners", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_user_blocking", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.team_discussions", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.content_references", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"installation\":{\"permissions\":{\"metadata\":\"read\",\"issues\":\"write\",\"contents\":\"read\"},\"repository_selection\":\"selected\",\"single_file_name\":\".github/workflow.yml\",\"repositories_url\":\"https://api.github.com/user/repos\",\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"has_multiple_single_files\":false,\"single_file_paths\":[]}}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Suspend an app installation", - "scope": "apps", - "id": "suspendInstallation", - "method": "PUT", - "url": "/app/installations/{installation_id}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#suspend-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unsuspend an app installation", - "scope": "apps", - "id": "unsuspendInstallation", - "method": "DELETE", - "url": "/app/installations/{installation_id}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#unsuspend-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a webhook configuration for an app", - "scope": "apps", - "id": "updateWebhookConfigForApp", - "method": "PATCH", - "url": "/app/hook/config", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/apps#update-a-webhook-configuration-for-an-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a check run", - "scope": "checks", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-runs", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/checks#create-a-check-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": ["queued", "in_progress"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"42\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - }, - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"42\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"in_progress\",\"conclusion\":null,\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":null,\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a check suite", - "scope": "checks", - "id": "createSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.2/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/checks#create-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head_sha", - "description": "The sha of the head commit.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response when the suite already exists", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" - } - ] - }, - { - "code": 201, - "description": "Response when the suite was created", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a check run", - "scope": "checks", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/checks#get-a-check-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_run_id", - "description": "The unique identifier of the check run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a check suite", - "scope": "checks", - "id": "getSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/checks#get-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_suite_id", - "description": "The unique identifier of the check suite.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List check run annotations", - "scope": "checks", - "id": "listAnnotations", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/checks#list-check-run-annotations", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_run_id", - "description": "The unique identifier of the check run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"path\":\"README.md\",\"start_line\":2,\"end_line\":2,\"start_column\":5,\"end_column\":10,\"annotation_level\":\"warning\",\"title\":\"Spell Checker\",\"message\":\"Check your spelling for 'banaas'.\",\"raw_details\":\"Do you mean 'bananas' or 'banana'?\",\"blob_href\":\"https://api.github.com/repos/github/rest-api-description/git/blobs/abc\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List check runs for a Git reference", - "scope": "checks", - "id": "listForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/checks#list-check-runs-for-a-git-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns check runs with the specified `status`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["queued", "in_progress", "completed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["latest", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "app_id", - "description": "", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List check runs in a check suite", - "scope": "checks", - "id": "listForSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/checks#list-check-runs-in-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_suite_id", - "description": "The unique identifier of the check suite.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns check runs with the specified `status`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["queued", "in_progress", "completed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["latest", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List check suites for a Git reference", - "scope": "checks", - "id": "listSuitesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/checks#list-check-suites-for-a-git-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "app_id", - "description": "Filters check suites by GitHub App `id`.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"check_suites\":[{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Rerequest a check suite", - "scope": "checks", - "id": "rerequestSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/checks#rerequest-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_suite_id", - "description": "The unique identifier of the check suite.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 201, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Update repository preferences for check suites", - "scope": "checks", - "id": "setSuitesPreferences", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-suites/preferences", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.2/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-repository-preferences-for-check-suites", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_trigger_checks", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#auto_trigger_checks-object) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_trigger_checks[].app_id", - "description": "The `id` of the GitHub App.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_trigger_checks[].setting", - "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"preferences\":{\"auto_trigger_checks\":[{\"app_id\":2,\"setting\":true},{\"app_id\":4,\"setting\":false}]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a check run", - "scope": "checks", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_run_id", - "description": "The unique identifier of the check run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the check. For example, \"code-coverage\".", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "details_url", - "description": "The URL of the integrator's site that has the full details of the check.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "external_id", - "description": "A reference for the run on the integrator's system.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "started_at", - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "The current status.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["queued", "in_progress", "completed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "conclusion", - "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "in": "BODY", - "type": "string", - "required": false, - "enum": [ - "action_required", - "cancelled", - "failure", - "neutral", - "success", - "skipped", - "stale", - "timed_out" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "completed_at", - "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#output-object-1) description.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.title", - "description": "**Required**.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.summary", - "description": "Can contain Markdown.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.text", - "description": "Can contain Markdown.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].path", - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].start_line", - "description": "The start line of the annotation.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].end_line", - "description": "The end line of the annotation.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].start_column", - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].end_column", - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].annotation_level", - "description": "The level of the annotation.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["notice", "warning", "failure"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].message", - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].title", - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].raw_details", - "description": "Details about this annotation. The maximum size is 64 KB.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.images", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#annotations-object-1) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.images[].alt", - "description": "The alternative text for the image.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.images[].image_url", - "description": "The full URL of the image.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.images[].caption", - "description": "A short image description.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actions", - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.2/rest/reference/checks#check-runs-and-requested-actions).\"", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actions[].label", - "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actions[].description", - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actions[].identifier", - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a code scanning analysis from a repository", - "scope": "codeScanning", - "id": "deleteAnalysis", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` and `repo:security_events` scopes.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\n**Note**: The ability to delete analyses was introduced in GitHub Enterprise Server 3.1.\nYou can delete analyses that were generated prior to installing this release,\nhowever, if you do so, you will lose information about fixed alerts for all such analyses,\nfor the relevant code scanning tool.\nWe recommend that you only delete analyses that were generated with earlier releases\nif you don't need the details of fixed alerts from pre-3.1 releases.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set\n(see the example default response below).\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin the set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find the deletable analysis for one of the sets,\nstep through deleting the analyses in that set,\nand then repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "analysis_id", - "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "confirm_delete", - "description": "Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"next_analysis_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41\",\"confirm_delete_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete\"}" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 403, - "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a code scanning alert", - "scope": "codeScanning", - "id": "getAlert", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#get-a-code-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"number\":42,\"created_at\":\"2020-06-19T11:21:34Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/42\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":54933897,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"description\":\"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\"name\":\"js/zipslip\",\"full_description\":\"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"help\":\"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\",\"help_uri\":\"https://codeql.github.com/\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"dismissed\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"}" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a code scanning analysis for a repository", - "scope": "codeScanning", - "id": "getAnalysis", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "analysis_id", - "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/main\",\"commit_sha\":\"c18c69115654ff0166991962832dc2bd7756e655\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:analyze\",\"environment\":\"{\\\"language\\\":\\\"javascript\\\"}\",\"error\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:analyze/language:javascript\",\"created_at\":\"2021-01-13T11:55:49Z\",\"results_count\":3,\"rules_count\":67,\"id\":3602840,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\"sarif_id\":\"47177e22-5596-11eb-80a1-c1e54ef945c6\",\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"deletable\":true,\"warning\":\"\"}" - } - ] - }, - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"runs\":[{\"tool\":{\"driver\":{\"name\":\"CodeQL\",\"organization\":\"GitHub\",\"semanticVersion\":\"1.0.0\",\"rules\":[{\"id\":\"js/unused-local-variable\",\"name\":\"js/unused-local-variable\"}]}},\"results\":[{\"guid\":\"326aa09f-9af8-13cf-9851-3d0e5183ec38\",\"message\":{\"text\":\"Unused variable foo.\"},\"locations\":[{\"physicalLocation\":{\"artifactLocation\":{\"uri\":\"file1.js\"},\"region\":{\"startLine\":1}}}],\"ruleId\":\"js/unused-local-variable\",\"properties\":[{\"github/alertNumber\":2},{\"github/alertUrl\":\"https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2\"}]}]}]}" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get information about a SARIF upload", - "scope": "codeScanning", - "id": "getSarif", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository).\" You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#list-recent-code-scanning-analyses-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sarif_id", - "description": "The SARIF ID obtained after uploading.", - "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": "{\"processing_status\":\"complete\",\"analyses_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6\"}" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { - "code": 404, - "description": "Not Found if the sarif id does not match any upload", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List instances of a code scanning alert", - "scope": "codeScanning", - "id": "listAlertInstances", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"fixed\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List code scanning alerts for a repository", - "scope": "codeScanning", - "id": "listAlertsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_guid", - "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "dismissed", "fixed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"number\":4,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/4\",\"state\":\"open\",\"dismissed_by\":null,\"dismissed_at\":null,\"dismissed_reason\":null,\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances\"},{\"number\":3,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/3\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances\"}]" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List instances of a code scanning alert", - "scope": "codeScanning", - "id": "listAlertsInstances", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"fixed\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": { - "before": { "scope": "codeScanning", "id": "listAlertsInstances" }, - "after": { "scope": "codeScanning", "id": "listAlertInstances" }, - "date": "2021-04-30", - "note": null - } - }, - { - "name": "List code scanning analyses for a repository", - "scope": "codeScanning", - "id": "listRecentAnalyses", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/analyses", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_guid", - "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sarif_id", - "description": "Filter analyses belonging to the same SARIF upload.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"ref\":\"refs/heads/main\",\"commit_sha\":\"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:analyze\",\"environment\":\"{\\\"language\\\":\\\"python\\\"}\",\"error\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:analyze/language:python\",\"created_at\":\"2020-08-27T15:05:21Z\",\"results_count\":17,\"rules_count\":49,\"id\":201,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\"sarif_id\":\"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"deletable\":true,\"warning\":\"\"},{\"ref\":\"refs/heads/my-branch\",\"commit_sha\":\"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\"analysis_key\":\".github/workflows/shiftleft.yml:build\",\"environment\":\"{}\",\"error\":\"\",\"category\":\".github/workflows/shiftleft.yml:build/\",\"created_at\":\"2020-08-31T22:46:44Z\",\"results_count\":17,\"rules_count\":32,\"id\":200,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\"sarif_id\":\"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\"tool\":{\"name\":\"Python Security Analysis\",\"guid\":null,\"version\":\"1.2.0\"},\"deletable\":true,\"warning\":\"\"}]" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a code scanning alert", - "scope": "codeScanning", - "id": "updateAlert", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#update-a-code-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["open", "dismissed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissed_reason", - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "in": "BODY", - "type": "string", - "required": false, - "enum": [null, "false positive", "won't fix", "used in tests"], - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"number\":42,\"created_at\":\"2020-08-25T21:28:36Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/42\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-09-02T22:34:56Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"description\":\"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\"name\":\"js/zipslip\",\"full_description\":\"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"help\":\"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\",\"help_uri\":\"https://codeql.github.com/\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"dismissed\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"}" - } - ] - }, - { - "code": 403, - "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Upload an analysis as SARIF data", - "scope": "codeScanning", - "id": "uploadSarif", - "method": "POST", - "url": "/repos/{owner}/{repo}/code-scanning/sarifs", - "isDeprecated": false, - "deprecationDate": null, - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/code-scanning#upload-a-sarif-file", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit to which the analysis you are uploading relates.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^[0-9a-fA-F]+$", - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sarif", - "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.2/code-security/secure-coding/sarif-support-for-code-scanning).\"", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "checkout_uri", - "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "started_at", - "description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_name", - "description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"id\":\"47177e22-5596-11eb-80a1-c1e54ef945c6\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6\"}" - } - ] - }, - { - "code": 400, - "description": "Bad Request if the sarif field is invalid", - "examples": null - }, - { - "code": 403, - "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 413, - "description": "Payload Too Large if the sarif field is too large", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all codes of conduct", - "scope": "codesOfConduct", - "id": "getAllCodesOfConduct", - "method": "GET", - "url": "/codes_of_conduct", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/codes-of-conduct#get-all-codes-of-conduct", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"citizen_code_of_conduct\",\"name\":\"Citizen Code of Conduct\",\"url\":\"https://api.github.com/codes_of_conduct/citizen_code_of_conduct\",\"html_url\":\"http://citizencodeofconduct.org/\"},{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"html_url\":\"https://www.contributor-covenant.org/version/2/0/code_of_conduct/\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a code of conduct", - "scope": "codesOfConduct", - "id": "getConductCode", - "method": "GET", - "url": "/codes_of_conduct/{key}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/codes-of-conduct#get-a-code-of-conduct", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\n to any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\",\"html_url\":\"http://contributor-covenant.org/version/1/4/\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the code of conduct for a repository", - "scope": "codesOfConduct", - "id": "getForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/community/code_of_conduct", - "isDeprecated": true, - "deprecationDate": "2021-09-29", - "description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.", - "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository", - "previews": [{ "name": "scarlet-witch" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\nto any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\nposting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lindseyb@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\",\"html_url\":\"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get emojis", - "scope": "emojis", - "id": "get", - "method": "GET", - "url": "/emojis", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all the emojis available to use on GitHub Enterprise Server.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/emojis#get-emojis", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"100\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8\",\"1234\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8\",\"+1\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8\",\"-1\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8\",\"1st_place_medal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8\",\"2nd_place_medal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8\",\"3rd_place_medal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8\",\"8ball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8\",\"a\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f170.png?v8\",\"ab\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f18e.png?v8\",\"abacus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ee.png?v8\",\"abc\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f524.png?v8\",\"abcd\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f521.png?v8\",\"accept\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f251.png?v8\",\"accordion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa97.png?v8\",\"adhesive_bandage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa79.png?v8\",\"adult\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1.png?v8\",\"aerial_tramway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a1.png?v8\",\"afghanistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1eb.png?v8\",\"airplane\":\"https://github.githubassets.com/images/icons/emoji/unicode/2708.png?v8\",\"aland_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fd.png?v8\",\"alarm_clock\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f0.png?v8\",\"albania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f1.png?v8\",\"alembic\":\"https://github.githubassets.com/images/icons/emoji/unicode/2697.png?v8\",\"algeria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ff.png?v8\",\"alien\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47d.png?v8\",\"ambulance\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f691.png?v8\",\"american_samoa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f8.png?v8\",\"amphora\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3fa.png?v8\",\"anatomical_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fac0.png?v8\",\"anchor\":\"https://github.githubassets.com/images/icons/emoji/unicode/2693.png?v8\",\"andorra\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e9.png?v8\",\"angel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47c.png?v8\",\"anger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a2.png?v8\",\"angola\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f4.png?v8\",\"angry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f620.png?v8\",\"anguilla\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ee.png?v8\",\"anguished\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f627.png?v8\",\"ant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41c.png?v8\",\"antarctica\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f6.png?v8\",\"antigua_barbuda\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ec.png?v8\",\"apple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34e.png?v8\",\"aquarius\":\"https://github.githubassets.com/images/icons/emoji/unicode/2652.png?v8\",\"argentina\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f7.png?v8\",\"aries\":\"https://github.githubassets.com/images/icons/emoji/unicode/2648.png?v8\",\"armenia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f2.png?v8\",\"arrow_backward\":\"https://github.githubassets.com/images/icons/emoji/unicode/25c0.png?v8\",\"arrow_double_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ec.png?v8\",\"arrow_double_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/23eb.png?v8\",\"arrow_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b07.png?v8\",\"arrow_down_small\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f53d.png?v8\",\"arrow_forward\":\"https://github.githubassets.com/images/icons/emoji/unicode/25b6.png?v8\",\"arrow_heading_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/2935.png?v8\",\"arrow_heading_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/2934.png?v8\",\"arrow_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b05.png?v8\",\"arrow_lower_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/2199.png?v8\",\"arrow_lower_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/2198.png?v8\",\"arrow_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/27a1.png?v8\",\"arrow_right_hook\":\"https://github.githubassets.com/images/icons/emoji/unicode/21aa.png?v8\",\"arrow_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b06.png?v8\",\"arrow_up_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/2195.png?v8\",\"arrow_up_small\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f53c.png?v8\",\"arrow_upper_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/2196.png?v8\",\"arrow_upper_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/2197.png?v8\",\"arrows_clockwise\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f503.png?v8\",\"arrows_counterclockwise\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f504.png?v8\",\"art\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png?v8\",\"articulated_lorry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69b.png?v8\",\"artificial_satellite\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f0.png?v8\",\"artist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a8.png?v8\",\"aruba\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fc.png?v8\",\"ascension_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e8.png?v8\",\"asterisk\":\"https://github.githubassets.com/images/icons/emoji/unicode/002a-20e3.png?v8\",\"astonished\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f632.png?v8\",\"astronaut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f680.png?v8\",\"athletic_shoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45f.png?v8\",\"atm\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e7.png?v8\",\"atom\":\"https://github.githubassets.com/images/icons/emoji/atom.png?v8\",\"atom_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/269b.png?v8\",\"australia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fa.png?v8\",\"austria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f9.png?v8\",\"auto_rickshaw\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6fa.png?v8\",\"avocado\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f951.png?v8\",\"axe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa93.png?v8\",\"azerbaijan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ff.png?v8\",\"b\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f171.png?v8\",\"baby\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f476.png?v8\",\"baby_bottle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37c.png?v8\",\"baby_chick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f424.png?v8\",\"baby_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6bc.png?v8\",\"back\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f519.png?v8\",\"bacon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f953.png?v8\",\"badger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a1.png?v8\",\"badminton\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f8.png?v8\",\"bagel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96f.png?v8\",\"baggage_claim\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c4.png?v8\",\"baguette_bread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f956.png?v8\",\"bahamas\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f8.png?v8\",\"bahrain\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ed.png?v8\",\"balance_scale\":\"https://github.githubassets.com/images/icons/emoji/unicode/2696.png?v8\",\"bald_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b2.png?v8\",\"bald_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b2.png?v8\",\"ballet_shoes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa70.png?v8\",\"balloon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f388.png?v8\",\"ballot_box\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5f3.png?v8\",\"ballot_box_with_check\":\"https://github.githubassets.com/images/icons/emoji/unicode/2611.png?v8\",\"bamboo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38d.png?v8\",\"banana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34c.png?v8\",\"bangbang\":\"https://github.githubassets.com/images/icons/emoji/unicode/203c.png?v8\",\"bangladesh\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e9.png?v8\",\"banjo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa95.png?v8\",\"bank\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e6.png?v8\",\"bar_chart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ca.png?v8\",\"barbados\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e7.png?v8\",\"barber\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f488.png?v8\",\"baseball\":\"https://github.githubassets.com/images/icons/emoji/unicode/26be.png?v8\",\"basecamp\":\"https://github.githubassets.com/images/icons/emoji/basecamp.png?v8\",\"basecampy\":\"https://github.githubassets.com/images/icons/emoji/basecampy.png?v8\",\"basket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fa.png?v8\",\"basketball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c0.png?v8\",\"basketball_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8\",\"basketball_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8\",\"bat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f987.png?v8\",\"bath\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c0.png?v8\",\"bathtub\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c1.png?v8\",\"battery\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50b.png?v8\",\"beach_umbrella\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d6.png?v8\",\"bear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43b.png?v8\",\"bearded_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d4.png?v8\",\"beaver\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ab.png?v8\",\"bed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6cf.png?v8\",\"bee\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8\",\"beer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37a.png?v8\",\"beers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37b.png?v8\",\"beetle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab2.png?v8\",\"beginner\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f530.png?v8\",\"belarus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fe.png?v8\",\"belgium\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ea.png?v8\",\"belize\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ff.png?v8\",\"bell\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f514.png?v8\",\"bell_pepper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad1.png?v8\",\"bellhop_bell\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ce.png?v8\",\"benin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ef.png?v8\",\"bento\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f371.png?v8\",\"bermuda\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f2.png?v8\",\"beverage_box\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c3.png?v8\",\"bhutan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f9.png?v8\",\"bicyclist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b4.png?v8\",\"bike\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b2.png?v8\",\"biking_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2642.png?v8\",\"biking_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2640.png?v8\",\"bikini\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f459.png?v8\",\"billed_cap\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e2.png?v8\",\"biohazard\":\"https://github.githubassets.com/images/icons/emoji/unicode/2623.png?v8\",\"bird\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f426.png?v8\",\"birthday\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f382.png?v8\",\"bison\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ac.png?v8\",\"black_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f408-2b1b.png?v8\",\"black_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/26ab.png?v8\",\"black_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4.png?v8\",\"black_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5a4.png?v8\",\"black_joker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f0cf.png?v8\",\"black_large_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b1b.png?v8\",\"black_medium_small_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25fe.png?v8\",\"black_medium_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25fc.png?v8\",\"black_nib\":\"https://github.githubassets.com/images/icons/emoji/unicode/2712.png?v8\",\"black_small_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25aa.png?v8\",\"black_square_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f532.png?v8\",\"blond_haired_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f471-2642.png?v8\",\"blond_haired_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f471.png?v8\",\"blond_haired_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8\",\"blonde_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8\",\"blossom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33c.png?v8\",\"blowfish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f421.png?v8\",\"blue_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d8.png?v8\",\"blue_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f699.png?v8\",\"blue_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f499.png?v8\",\"blue_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e6.png?v8\",\"blueberries\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad0.png?v8\",\"blush\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60a.png?v8\",\"boar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f417.png?v8\",\"boat\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8\",\"bolivia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f4.png?v8\",\"bomb\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a3.png?v8\",\"bone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b4.png?v8\",\"book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8\",\"bookmark\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f516.png?v8\",\"bookmark_tabs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d1.png?v8\",\"books\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png?v8\",\"boom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8\",\"boomerang\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa83.png?v8\",\"boot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f462.png?v8\",\"bosnia_herzegovina\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e6.png?v8\",\"botswana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fc.png?v8\",\"bouncing_ball_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8\",\"bouncing_ball_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9.png?v8\",\"bouncing_ball_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8\",\"bouquet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f490.png?v8\",\"bouvet_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fb.png?v8\",\"bow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f647.png?v8\",\"bow_and_arrow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f9.png?v8\",\"bowing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f647-2642.png?v8\",\"bowing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f647-2640.png?v8\",\"bowl_with_spoon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f963.png?v8\",\"bowling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b3.png?v8\",\"bowtie\":\"https://github.githubassets.com/images/icons/emoji/bowtie.png?v8\",\"boxing_glove\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94a.png?v8\",\"boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f466.png?v8\",\"brain\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e0.png?v8\",\"brazil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f7.png?v8\",\"bread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35e.png?v8\",\"breast_feeding\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f931.png?v8\",\"bricks\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f1.png?v8\",\"bride_with_veil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8\",\"bridge_at_night\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f309.png?v8\",\"briefcase\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4bc.png?v8\",\"british_indian_ocean_territory\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f4.png?v8\",\"british_virgin_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ec.png?v8\",\"broccoli\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f966.png?v8\",\"broken_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f494.png?v8\",\"broom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f9.png?v8\",\"brown_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e4.png?v8\",\"brown_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f90e.png?v8\",\"brown_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7eb.png?v8\",\"brunei\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f3.png?v8\",\"bubble_tea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cb.png?v8\",\"bucket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa3.png?v8\",\"bug\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png?v8\",\"building_construction\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png?v8\",\"bulb\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png?v8\",\"bulgaria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ec.png?v8\",\"bullettrain_front\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f685.png?v8\",\"bullettrain_side\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f684.png?v8\",\"burkina_faso\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1eb.png?v8\",\"burrito\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32f.png?v8\",\"burundi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ee.png?v8\",\"bus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68c.png?v8\",\"business_suit_levitating\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f574.png?v8\",\"busstop\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68f.png?v8\",\"bust_in_silhouette\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f464.png?v8\",\"busts_in_silhouette\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f465.png?v8\",\"butter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c8.png?v8\",\"butterfly\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98b.png?v8\",\"cactus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f335.png?v8\",\"cake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f370.png?v8\",\"calendar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c6.png?v8\",\"call_me_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f919.png?v8\",\"calling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f2.png?v8\",\"cambodia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ed.png?v8\",\"camel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png?v8\",\"camera\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f7.png?v8\",\"camera_flash\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f8.png?v8\",\"cameroon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f2.png?v8\",\"camping\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d5.png?v8\",\"canada\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e6.png?v8\",\"canary_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e8.png?v8\",\"cancer\":\"https://github.githubassets.com/images/icons/emoji/unicode/264b.png?v8\",\"candle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f56f.png?v8\",\"candy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36c.png?v8\",\"canned_food\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96b.png?v8\",\"canoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f6.png?v8\",\"cape_verde\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fb.png?v8\",\"capital_abcd\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f520.png?v8\",\"capricorn\":\"https://github.githubassets.com/images/icons/emoji/unicode/2651.png?v8\",\"car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8\",\"card_file_box\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5c3.png?v8\",\"card_index\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c7.png?v8\",\"card_index_dividers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png?v8\",\"caribbean_netherlands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f6.png?v8\",\"carousel_horse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a0.png?v8\",\"carpentry_saw\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9a.png?v8\",\"carrot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f955.png?v8\",\"cartwheeling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f938.png?v8\",\"cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f431.png?v8\",\"cat2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f408.png?v8\",\"cayman_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fe.png?v8\",\"cd\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4bf.png?v8\",\"central_african_republic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1eb.png?v8\",\"ceuta_melilla\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e6.png?v8\",\"chad\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e9.png?v8\",\"chains\":\"https://github.githubassets.com/images/icons/emoji/unicode/26d3.png?v8\",\"chair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa91.png?v8\",\"champagne\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37e.png?v8\",\"chart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b9.png?v8\",\"chart_with_downwards_trend\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c9.png?v8\",\"chart_with_upwards_trend\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c8.png?v8\",\"checkered_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png?v8\",\"cheese\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c0.png?v8\",\"cherries\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f352.png?v8\",\"cherry_blossom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f338.png?v8\",\"chess_pawn\":\"https://github.githubassets.com/images/icons/emoji/unicode/265f.png?v8\",\"chestnut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f330.png?v8\",\"chicken\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f414.png?v8\",\"child\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d2.png?v8\",\"children_crossing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b8.png?v8\",\"chile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f1.png?v8\",\"chipmunk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43f.png?v8\",\"chocolate_bar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36b.png?v8\",\"chopsticks\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f962.png?v8\",\"christmas_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fd.png?v8\",\"christmas_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f384.png?v8\",\"church\":\"https://github.githubassets.com/images/icons/emoji/unicode/26ea.png?v8\",\"cinema\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a6.png?v8\",\"circus_tent\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3aa.png?v8\",\"city_sunrise\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f307.png?v8\",\"city_sunset\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f306.png?v8\",\"cityscape\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d9.png?v8\",\"cl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f191.png?v8\",\"clamp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5dc.png?v8\",\"clap\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44f.png?v8\",\"clapper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ac.png?v8\",\"classical_building\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3db.png?v8\",\"climbing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d7.png?v8\",\"climbing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2642.png?v8\",\"climbing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2640.png?v8\",\"clinking_glasses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f942.png?v8\",\"clipboard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png?v8\",\"clipperton_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f5.png?v8\",\"clock1\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f550.png?v8\",\"clock10\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f559.png?v8\",\"clock1030\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f565.png?v8\",\"clock11\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55a.png?v8\",\"clock1130\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f566.png?v8\",\"clock12\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55b.png?v8\",\"clock1230\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f567.png?v8\",\"clock130\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55c.png?v8\",\"clock2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f551.png?v8\",\"clock230\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55d.png?v8\",\"clock3\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f552.png?v8\",\"clock330\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55e.png?v8\",\"clock4\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f553.png?v8\",\"clock430\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55f.png?v8\",\"clock5\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f554.png?v8\",\"clock530\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f560.png?v8\",\"clock6\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f555.png?v8\",\"clock630\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f561.png?v8\",\"clock7\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f556.png?v8\",\"clock730\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f562.png?v8\",\"clock8\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f557.png?v8\",\"clock830\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f563.png?v8\",\"clock9\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f558.png?v8\",\"clock930\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f564.png?v8\",\"closed_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d5.png?v8\",\"closed_lock_with_key\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f510.png?v8\",\"closed_umbrella\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f302.png?v8\",\"cloud\":\"https://github.githubassets.com/images/icons/emoji/unicode/2601.png?v8\",\"cloud_with_lightning\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f329.png?v8\",\"cloud_with_lightning_and_rain\":\"https://github.githubassets.com/images/icons/emoji/unicode/26c8.png?v8\",\"cloud_with_rain\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f327.png?v8\",\"cloud_with_snow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f328.png?v8\",\"clown_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f921.png?v8\",\"clubs\":\"https://github.githubassets.com/images/icons/emoji/unicode/2663.png?v8\",\"cn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8\",\"coat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e5.png?v8\",\"cockroach\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab3.png?v8\",\"cocktail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f378.png?v8\",\"coconut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f965.png?v8\",\"cocos_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e8.png?v8\",\"coffee\":\"https://github.githubassets.com/images/icons/emoji/unicode/2615.png?v8\",\"coffin\":\"https://github.githubassets.com/images/icons/emoji/unicode/26b0.png?v8\",\"coin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa99.png?v8\",\"cold_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f976.png?v8\",\"cold_sweat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f630.png?v8\",\"collision\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8\",\"colombia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f4.png?v8\",\"comet\":\"https://github.githubassets.com/images/icons/emoji/unicode/2604.png?v8\",\"comoros\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f2.png?v8\",\"compass\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ed.png?v8\",\"computer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png?v8\",\"computer_mouse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5b1.png?v8\",\"confetti_ball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38a.png?v8\",\"confounded\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f616.png?v8\",\"confused\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f615.png?v8\",\"congo_brazzaville\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ec.png?v8\",\"congo_kinshasa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e9.png?v8\",\"congratulations\":\"https://github.githubassets.com/images/icons/emoji/unicode/3297.png?v8\",\"construction\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png?v8\",\"construction_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f477.png?v8\",\"construction_worker_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f477-2642.png?v8\",\"construction_worker_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f477-2640.png?v8\",\"control_knobs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f39b.png?v8\",\"convenience_store\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ea.png?v8\",\"cook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f373.png?v8\",\"cook_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f0.png?v8\",\"cookie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8\",\"cool\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8\",\"cop\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8\",\"copyright\":\"https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8\",\"corn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8\",\"costa_rica\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8\",\"cote_divoire\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ee.png?v8\",\"couch_and_lamp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6cb.png?v8\",\"couple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46b.png?v8\",\"couple_with_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f491.png?v8\",\"couple_with_heart_man_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f468.png?v8\",\"couple_with_heart_woman_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f468.png?v8\",\"couple_with_heart_woman_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f469.png?v8\",\"couplekiss\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48f.png?v8\",\"couplekiss_man_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f48b-1f468.png?v8\",\"couplekiss_man_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f468.png?v8\",\"couplekiss_woman_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f469.png?v8\",\"cow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42e.png?v8\",\"cow2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f404.png?v8\",\"cowboy_hat_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f920.png?v8\",\"crab\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f980.png?v8\",\"crayon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f58d.png?v8\",\"credit_card\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b3.png?v8\",\"crescent_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f319.png?v8\",\"cricket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f997.png?v8\",\"cricket_game\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cf.png?v8\",\"croatia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f7.png?v8\",\"crocodile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40a.png?v8\",\"croissant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f950.png?v8\",\"crossed_fingers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91e.png?v8\",\"crossed_flags\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38c.png?v8\",\"crossed_swords\":\"https://github.githubassets.com/images/icons/emoji/unicode/2694.png?v8\",\"crown\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f451.png?v8\",\"cry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f622.png?v8\",\"crying_cat_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63f.png?v8\",\"crystal_ball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52e.png?v8\",\"cuba\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fa.png?v8\",\"cucumber\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f952.png?v8\",\"cup_with_straw\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f964.png?v8\",\"cupcake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c1.png?v8\",\"cupid\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f498.png?v8\",\"curacao\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fc.png?v8\",\"curling_stone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94c.png?v8\",\"curly_haired_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b1.png?v8\",\"curly_haired_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b1.png?v8\",\"curly_loop\":\"https://github.githubassets.com/images/icons/emoji/unicode/27b0.png?v8\",\"currency_exchange\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b1.png?v8\",\"curry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35b.png?v8\",\"cursing_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92c.png?v8\",\"custard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36e.png?v8\",\"customs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c3.png?v8\",\"cut_of_meat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f969.png?v8\",\"cyclone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f300.png?v8\",\"cyprus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fe.png?v8\",\"czech_republic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ff.png?v8\",\"dagger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5e1.png?v8\",\"dancer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8\",\"dancers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46f.png?v8\",\"dancing_men\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2642.png?v8\",\"dancing_women\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2640.png?v8\",\"dango\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f361.png?v8\",\"dark_sunglasses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f576.png?v8\",\"dart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3af.png?v8\",\"dash\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a8.png?v8\",\"date\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c5.png?v8\",\"de\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8\",\"deaf_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2642.png?v8\",\"deaf_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cf.png?v8\",\"deaf_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2640.png?v8\",\"deciduous_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f333.png?v8\",\"deer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98c.png?v8\",\"denmark\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f0.png?v8\",\"department_store\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ec.png?v8\",\"derelict_house\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3da.png?v8\",\"desert\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3dc.png?v8\",\"desert_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3dd.png?v8\",\"desktop_computer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5a5.png?v8\",\"detective\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f575.png?v8\",\"diamond_shape_with_a_dot_inside\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a0.png?v8\",\"diamonds\":\"https://github.githubassets.com/images/icons/emoji/unicode/2666.png?v8\",\"diego_garcia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ec.png?v8\",\"disappointed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61e.png?v8\",\"disappointed_relieved\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f625.png?v8\",\"disguised_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f978.png?v8\",\"diving_mask\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93f.png?v8\",\"diya_lamp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa94.png?v8\",\"dizzy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png?v8\",\"dizzy_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f635.png?v8\",\"djibouti\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ef.png?v8\",\"dna\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ec.png?v8\",\"do_not_litter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6af.png?v8\",\"dodo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a4.png?v8\",\"dog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8\",\"dog2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f415.png?v8\",\"dollar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b5.png?v8\",\"dolls\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38e.png?v8\",\"dolphin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8\",\"dominica\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f2.png?v8\",\"dominican_republic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f4.png?v8\",\"door\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6aa.png?v8\",\"doughnut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f369.png?v8\",\"dove\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f54a.png?v8\",\"dragon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f409.png?v8\",\"dragon_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f432.png?v8\",\"dress\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f457.png?v8\",\"dromedary_camel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42a.png?v8\",\"drooling_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f924.png?v8\",\"drop_of_blood\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa78.png?v8\",\"droplet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a7.png?v8\",\"drum\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f941.png?v8\",\"duck\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f986.png?v8\",\"dumpling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95f.png?v8\",\"dvd\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c0.png?v8\",\"e-mail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8\",\"eagle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f985.png?v8\",\"ear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f442.png?v8\",\"ear_of_rice\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33e.png?v8\",\"ear_with_hearing_aid\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9bb.png?v8\",\"earth_africa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30d.png?v8\",\"earth_americas\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30e.png?v8\",\"earth_asia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30f.png?v8\",\"ecuador\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e8.png?v8\",\"egg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95a.png?v8\",\"eggplant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f346.png?v8\",\"egypt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ec.png?v8\",\"eight\":\"https://github.githubassets.com/images/icons/emoji/unicode/0038-20e3.png?v8\",\"eight_pointed_black_star\":\"https://github.githubassets.com/images/icons/emoji/unicode/2734.png?v8\",\"eight_spoked_asterisk\":\"https://github.githubassets.com/images/icons/emoji/unicode/2733.png?v8\",\"eject_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23cf.png?v8\",\"el_salvador\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fb.png?v8\",\"electric_plug\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png?v8\",\"electron\":\"https://github.githubassets.com/images/icons/emoji/electron.png?v8\",\"elephant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f418.png?v8\",\"elevator\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d7.png?v8\",\"elf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dd.png?v8\",\"elf_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2642.png?v8\",\"elf_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2640.png?v8\",\"email\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8\",\"end\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51a.png?v8\",\"england\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0065-e006e-e0067-e007f.png?v8\",\"envelope\":\"https://github.githubassets.com/images/icons/emoji/unicode/2709.png?v8\",\"envelope_with_arrow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e9.png?v8\",\"equatorial_guinea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f6.png?v8\",\"eritrea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f7.png?v8\",\"es\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8\",\"estonia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ea.png?v8\",\"ethiopia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f9.png?v8\",\"eu\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8\",\"euro\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b6.png?v8\",\"european_castle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f0.png?v8\",\"european_post_office\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e4.png?v8\",\"european_union\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8\",\"evergreen_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f332.png?v8\",\"exclamation\":\"https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8\",\"exploding_head\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92f.png?v8\",\"expressionless\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f611.png?v8\",\"eye\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f441.png?v8\",\"eye_speech_bubble\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f441-1f5e8.png?v8\",\"eyeglasses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f453.png?v8\",\"eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f440.png?v8\",\"face_exhaling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62e-1f4a8.png?v8\",\"face_in_clouds\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f636-1f32b.png?v8\",\"face_with_head_bandage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f915.png?v8\",\"face_with_spiral_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f635-1f4ab.png?v8\",\"face_with_thermometer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f912.png?v8\",\"facepalm\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f926.png?v8\",\"facepunch\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8\",\"factory\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ed.png?v8\",\"factory_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3ed.png?v8\",\"fairy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9da.png?v8\",\"fairy_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2642.png?v8\",\"fairy_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2640.png?v8\",\"falafel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c6.png?v8\",\"falkland_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f0.png?v8\",\"fallen_leaf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f342.png?v8\",\"family\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46a.png?v8\",\"family_man_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466.png?v8\",\"family_man_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466-1f466.png?v8\",\"family_man_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467.png?v8\",\"family_man_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f466.png?v8\",\"family_man_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f467.png?v8\",\"family_man_man_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466.png?v8\",\"family_man_man_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466-1f466.png?v8\",\"family_man_man_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467.png?v8\",\"family_man_man_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f466.png?v8\",\"family_man_man_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f467.png?v8\",\"family_man_woman_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466.png?v8\",\"family_man_woman_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466-1f466.png?v8\",\"family_man_woman_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467.png?v8\",\"family_man_woman_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f466.png?v8\",\"family_man_woman_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f467.png?v8\",\"family_woman_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466.png?v8\",\"family_woman_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466-1f466.png?v8\",\"family_woman_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467.png?v8\",\"family_woman_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f466.png?v8\",\"family_woman_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f467.png?v8\",\"family_woman_woman_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466.png?v8\",\"family_woman_woman_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466-1f466.png?v8\",\"family_woman_woman_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467.png?v8\",\"family_woman_woman_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f466.png?v8\",\"family_woman_woman_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f467.png?v8\",\"farmer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f33e.png?v8\",\"faroe_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f4.png?v8\",\"fast_forward\":\"https://github.githubassets.com/images/icons/emoji/unicode/23e9.png?v8\",\"fax\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e0.png?v8\",\"fearful\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f628.png?v8\",\"feather\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab6.png?v8\",\"feelsgood\":\"https://github.githubassets.com/images/icons/emoji/feelsgood.png?v8\",\"feet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8\",\"female_detective\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f575-2640.png?v8\",\"female_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2640.png?v8\",\"ferris_wheel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a1.png?v8\",\"ferry\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f4.png?v8\",\"field_hockey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d1.png?v8\",\"fiji\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ef.png?v8\",\"file_cabinet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5c4.png?v8\",\"file_folder\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c1.png?v8\",\"film_projector\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4fd.png?v8\",\"film_strip\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f39e.png?v8\",\"finland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ee.png?v8\",\"finnadie\":\"https://github.githubassets.com/images/icons/emoji/finnadie.png?v8\",\"fire\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f525.png?v8\",\"fire_engine\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f692.png?v8\",\"fire_extinguisher\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png?v8\",\"firecracker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e8.png?v8\",\"firefighter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f692.png?v8\",\"fireworks\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f386.png?v8\",\"first_quarter_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f313.png?v8\",\"first_quarter_moon_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31b.png?v8\",\"fish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41f.png?v8\",\"fish_cake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f365.png?v8\",\"fishing_pole_and_fish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a3.png?v8\",\"fist\":\"https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8\",\"fist_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91b.png?v8\",\"fist_oncoming\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8\",\"fist_raised\":\"https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8\",\"fist_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91c.png?v8\",\"five\":\"https://github.githubassets.com/images/icons/emoji/unicode/0035-20e3.png?v8\",\"flags\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38f.png?v8\",\"flamingo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a9.png?v8\",\"flashlight\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f526.png?v8\",\"flat_shoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97f.png?v8\",\"flatbread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad3.png?v8\",\"fleur_de_lis\":\"https://github.githubassets.com/images/icons/emoji/unicode/269c.png?v8\",\"flight_arrival\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ec.png?v8\",\"flight_departure\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6eb.png?v8\",\"flipper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8\",\"floppy_disk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4be.png?v8\",\"flower_playing_cards\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b4.png?v8\",\"flushed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f633.png?v8\",\"fly\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab0.png?v8\",\"flying_disc\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94f.png?v8\",\"flying_saucer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f8.png?v8\",\"fog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32b.png?v8\",\"foggy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f301.png?v8\",\"fondue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad5.png?v8\",\"foot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b6.png?v8\",\"football\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c8.png?v8\",\"footprints\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f463.png?v8\",\"fork_and_knife\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f374.png?v8\",\"fortune_cookie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f960.png?v8\",\"fountain\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f2.png?v8\",\"fountain_pen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f58b.png?v8\",\"four\":\"https://github.githubassets.com/images/icons/emoji/unicode/0034-20e3.png?v8\",\"four_leaf_clover\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f340.png?v8\",\"fox_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98a.png?v8\",\"fr\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f7.png?v8\",\"framed_picture\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5bc.png?v8\",\"free\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f193.png?v8\",\"french_guiana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1eb.png?v8\",\"french_polynesia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1eb.png?v8\",\"french_southern_territories\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1eb.png?v8\",\"fried_egg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f373.png?v8\",\"fried_shrimp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f364.png?v8\",\"fries\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35f.png?v8\",\"frog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f438.png?v8\",\"frowning\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f626.png?v8\",\"frowning_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/2639.png?v8\",\"frowning_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2642.png?v8\",\"frowning_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64d.png?v8\",\"frowning_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2640.png?v8\",\"fu\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8\",\"fuelpump\":\"https://github.githubassets.com/images/icons/emoji/unicode/26fd.png?v8\",\"full_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f315.png?v8\",\"full_moon_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31d.png?v8\",\"funeral_urn\":\"https://github.githubassets.com/images/icons/emoji/unicode/26b1.png?v8\",\"gabon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e6.png?v8\",\"gambia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f2.png?v8\",\"game_die\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b2.png?v8\",\"garlic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c4.png?v8\",\"gb\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8\",\"gear\":\"https://github.githubassets.com/images/icons/emoji/unicode/2699.png?v8\",\"gem\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48e.png?v8\",\"gemini\":\"https://github.githubassets.com/images/icons/emoji/unicode/264a.png?v8\",\"genie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9de.png?v8\",\"genie_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2642.png?v8\",\"genie_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2640.png?v8\",\"georgia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ea.png?v8\",\"ghana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ed.png?v8\",\"ghost\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47b.png?v8\",\"gibraltar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ee.png?v8\",\"gift\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f381.png?v8\",\"gift_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49d.png?v8\",\"giraffe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f992.png?v8\",\"girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f467.png?v8\",\"globe_with_meridians\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f310.png?v8\",\"gloves\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e4.png?v8\",\"goal_net\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f945.png?v8\",\"goat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f410.png?v8\",\"goberserk\":\"https://github.githubassets.com/images/icons/emoji/goberserk.png?v8\",\"godmode\":\"https://github.githubassets.com/images/icons/emoji/godmode.png?v8\",\"goggles\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97d.png?v8\",\"golf\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f3.png?v8\",\"golfing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cc.png?v8\",\"golfing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2642.png?v8\",\"golfing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2640.png?v8\",\"gorilla\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98d.png?v8\",\"grapes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f347.png?v8\",\"greece\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f7.png?v8\",\"green_apple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34f.png?v8\",\"green_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d7.png?v8\",\"green_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e2.png?v8\",\"green_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49a.png?v8\",\"green_salad\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f957.png?v8\",\"green_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e9.png?v8\",\"greenland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f1.png?v8\",\"grenada\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e9.png?v8\",\"grey_exclamation\":\"https://github.githubassets.com/images/icons/emoji/unicode/2755.png?v8\",\"grey_question\":\"https://github.githubassets.com/images/icons/emoji/unicode/2754.png?v8\",\"grimacing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62c.png?v8\",\"grin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f601.png?v8\",\"grinning\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f600.png?v8\",\"guadeloupe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f5.png?v8\",\"guam\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fa.png?v8\",\"guard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f482.png?v8\",\"guardsman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f482-2642.png?v8\",\"guardswoman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f482-2640.png?v8\",\"guatemala\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f9.png?v8\",\"guernsey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ec.png?v8\",\"guide_dog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ae.png?v8\",\"guinea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f3.png?v8\",\"guinea_bissau\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fc.png?v8\",\"guitar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b8.png?v8\",\"gun\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52b.png?v8\",\"guyana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fe.png?v8\",\"haircut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f487.png?v8\",\"haircut_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f487-2642.png?v8\",\"haircut_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f487-2640.png?v8\",\"haiti\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f9.png?v8\",\"hamburger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f354.png?v8\",\"hammer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f528.png?v8\",\"hammer_and_pick\":\"https://github.githubassets.com/images/icons/emoji/unicode/2692.png?v8\",\"hammer_and_wrench\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png?v8\",\"hamster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f439.png?v8\",\"hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8\",\"hand_over_mouth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92d.png?v8\",\"handbag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45c.png?v8\",\"handball_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93e.png?v8\",\"handshake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91d.png?v8\",\"hankey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8\",\"hash\":\"https://github.githubassets.com/images/icons/emoji/unicode/0023-20e3.png?v8\",\"hatched_chick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f425.png?v8\",\"hatching_chick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f423.png?v8\",\"headphones\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a7.png?v8\",\"headstone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa6.png?v8\",\"health_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2695.png?v8\",\"hear_no_evil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f649.png?v8\",\"heard_mcdonald_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f2.png?v8\",\"heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/2764.png?v8\",\"heart_decoration\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49f.png?v8\",\"heart_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60d.png?v8\",\"heart_eyes_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63b.png?v8\",\"heart_on_fire\":\"https://github.githubassets.com/images/icons/emoji/unicode/2764-1f525.png?v8\",\"heartbeat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f493.png?v8\",\"heartpulse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f497.png?v8\",\"hearts\":\"https://github.githubassets.com/images/icons/emoji/unicode/2665.png?v8\",\"heavy_check_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/2714.png?v8\",\"heavy_division_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2797.png?v8\",\"heavy_dollar_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b2.png?v8\",\"heavy_exclamation_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8\",\"heavy_heart_exclamation\":\"https://github.githubassets.com/images/icons/emoji/unicode/2763.png?v8\",\"heavy_minus_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2796.png?v8\",\"heavy_multiplication_x\":\"https://github.githubassets.com/images/icons/emoji/unicode/2716.png?v8\",\"heavy_plus_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2795.png?v8\",\"hedgehog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f994.png?v8\",\"helicopter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f681.png?v8\",\"herb\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33f.png?v8\",\"hibiscus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33a.png?v8\",\"high_brightness\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f506.png?v8\",\"high_heel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f460.png?v8\",\"hiking_boot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97e.png?v8\",\"hindu_temple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d5.png?v8\",\"hippopotamus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99b.png?v8\",\"hocho\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8\",\"hole\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f573.png?v8\",\"honduras\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f3.png?v8\",\"honey_pot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36f.png?v8\",\"honeybee\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8\",\"hong_kong\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f0.png?v8\",\"hook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9d.png?v8\",\"horse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f434.png?v8\",\"horse_racing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c7.png?v8\",\"hospital\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e5.png?v8\",\"hot_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f975.png?v8\",\"hot_pepper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f336.png?v8\",\"hotdog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32d.png?v8\",\"hotel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e8.png?v8\",\"hotsprings\":\"https://github.githubassets.com/images/icons/emoji/unicode/2668.png?v8\",\"hourglass\":\"https://github.githubassets.com/images/icons/emoji/unicode/231b.png?v8\",\"hourglass_flowing_sand\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f3.png?v8\",\"house\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e0.png?v8\",\"house_with_garden\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e1.png?v8\",\"houses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d8.png?v8\",\"hugs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f917.png?v8\",\"hungary\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1fa.png?v8\",\"hurtrealbad\":\"https://github.githubassets.com/images/icons/emoji/hurtrealbad.png?v8\",\"hushed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62f.png?v8\",\"hut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d6.png?v8\",\"ice_cream\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f368.png?v8\",\"ice_cube\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ca.png?v8\",\"ice_hockey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d2.png?v8\",\"ice_skate\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f8.png?v8\",\"icecream\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f366.png?v8\",\"iceland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f8.png?v8\",\"id\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f194.png?v8\",\"ideograph_advantage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f250.png?v8\",\"imp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47f.png?v8\",\"inbox_tray\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e5.png?v8\",\"incoming_envelope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e8.png?v8\",\"india\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f3.png?v8\",\"indonesia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e9.png?v8\",\"infinity\":\"https://github.githubassets.com/images/icons/emoji/unicode/267e.png?v8\",\"information_desk_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8\",\"information_source\":\"https://github.githubassets.com/images/icons/emoji/unicode/2139.png?v8\",\"innocent\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f607.png?v8\",\"interrobang\":\"https://github.githubassets.com/images/icons/emoji/unicode/2049.png?v8\",\"iphone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f1.png?v8\",\"iran\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f7.png?v8\",\"iraq\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f6.png?v8\",\"ireland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1ea.png?v8\",\"isle_of_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f2.png?v8\",\"israel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f1.png?v8\",\"it\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f9.png?v8\",\"izakaya_lantern\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8\",\"jack_o_lantern\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f383.png?v8\",\"jamaica\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f2.png?v8\",\"japan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fe.png?v8\",\"japanese_castle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ef.png?v8\",\"japanese_goblin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47a.png?v8\",\"japanese_ogre\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f479.png?v8\",\"jeans\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f456.png?v8\",\"jersey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1ea.png?v8\",\"jigsaw\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e9.png?v8\",\"jordan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f4.png?v8\",\"joy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f602.png?v8\",\"joy_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f639.png?v8\",\"joystick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f579.png?v8\",\"jp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f5.png?v8\",\"judge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2696.png?v8\",\"juggling_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f939.png?v8\",\"kangaroo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f998.png?v8\",\"kazakhstan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ff.png?v8\",\"kenya\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ea.png?v8\",\"key\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f511.png?v8\",\"keyboard\":\"https://github.githubassets.com/images/icons/emoji/unicode/2328.png?v8\",\"keycap_ten\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51f.png?v8\",\"kick_scooter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f4.png?v8\",\"kimono\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f458.png?v8\",\"kiribati\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ee.png?v8\",\"kiss\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48b.png?v8\",\"kissing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f617.png?v8\",\"kissing_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63d.png?v8\",\"kissing_closed_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61a.png?v8\",\"kissing_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f618.png?v8\",\"kissing_smiling_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f619.png?v8\",\"kite\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa81.png?v8\",\"kiwi_fruit\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95d.png?v8\",\"kneeling_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2642.png?v8\",\"kneeling_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ce.png?v8\",\"kneeling_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2640.png?v8\",\"knife\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8\",\"knot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa2.png?v8\",\"koala\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f428.png?v8\",\"koko\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f201.png?v8\",\"kosovo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fd-1f1f0.png?v8\",\"kr\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f7.png?v8\",\"kuwait\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fc.png?v8\",\"kyrgyzstan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ec.png?v8\",\"lab_coat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97c.png?v8\",\"label\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f7.png?v8\",\"lacrosse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94d.png?v8\",\"ladder\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9c.png?v8\",\"lady_beetle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41e.png?v8\",\"lantern\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8\",\"laos\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e6.png?v8\",\"large_blue_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f535.png?v8\",\"large_blue_diamond\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f537.png?v8\",\"large_orange_diamond\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f536.png?v8\",\"last_quarter_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f317.png?v8\",\"last_quarter_moon_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31c.png?v8\",\"latin_cross\":\"https://github.githubassets.com/images/icons/emoji/unicode/271d.png?v8\",\"latvia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fb.png?v8\",\"laughing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8\",\"leafy_green\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96c.png?v8\",\"leaves\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f343.png?v8\",\"lebanon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e7.png?v8\",\"ledger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d2.png?v8\",\"left_luggage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c5.png?v8\",\"left_right_arrow\":\"https://github.githubassets.com/images/icons/emoji/unicode/2194.png?v8\",\"left_speech_bubble\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5e8.png?v8\",\"leftwards_arrow_with_hook\":\"https://github.githubassets.com/images/icons/emoji/unicode/21a9.png?v8\",\"leg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b5.png?v8\",\"lemon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34b.png?v8\",\"leo\":\"https://github.githubassets.com/images/icons/emoji/unicode/264c.png?v8\",\"leopard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f406.png?v8\",\"lesotho\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f8.png?v8\",\"level_slider\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f39a.png?v8\",\"liberia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f7.png?v8\",\"libra\":\"https://github.githubassets.com/images/icons/emoji/unicode/264e.png?v8\",\"libya\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fe.png?v8\",\"liechtenstein\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1ee.png?v8\",\"light_rail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f688.png?v8\",\"link\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f517.png?v8\",\"lion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f981.png?v8\",\"lips\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f444.png?v8\",\"lipstick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f484.png?v8\",\"lithuania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f9.png?v8\",\"lizard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98e.png?v8\",\"llama\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f999.png?v8\",\"lobster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99e.png?v8\",\"lock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f512.png?v8\",\"lock_with_ink_pen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50f.png?v8\",\"lollipop\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36d.png?v8\",\"long_drum\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa98.png?v8\",\"loop\":\"https://github.githubassets.com/images/icons/emoji/unicode/27bf.png?v8\",\"lotion_bottle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f4.png?v8\",\"lotus_position\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d8.png?v8\",\"lotus_position_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2642.png?v8\",\"lotus_position_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2640.png?v8\",\"loud_sound\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50a.png?v8\",\"loudspeaker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e2.png?v8\",\"love_hotel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e9.png?v8\",\"love_letter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48c.png?v8\",\"love_you_gesture\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91f.png?v8\",\"low_brightness\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f505.png?v8\",\"luggage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f3.png?v8\",\"lungs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fac1.png?v8\",\"luxembourg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fa.png?v8\",\"lying_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f925.png?v8\",\"m\":\"https://github.githubassets.com/images/icons/emoji/unicode/24c2.png?v8\",\"macau\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f4.png?v8\",\"macedonia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f0.png?v8\",\"madagascar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ec.png?v8\",\"mag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50d.png?v8\",\"mag_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png?v8\",\"mage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d9.png?v8\",\"mage_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2642.png?v8\",\"mage_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2640.png?v8\",\"magic_wand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa84.png?v8\",\"magnet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f2.png?v8\",\"mahjong\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f004.png?v8\",\"mailbox\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4eb.png?v8\",\"mailbox_closed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ea.png?v8\",\"mailbox_with_mail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ec.png?v8\",\"mailbox_with_no_mail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ed.png?v8\",\"malawi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fc.png?v8\",\"malaysia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fe.png?v8\",\"maldives\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fb.png?v8\",\"male_detective\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f575-2642.png?v8\",\"male_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2642.png?v8\",\"mali\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f1.png?v8\",\"malta\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f9.png?v8\",\"mammoth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a3.png?v8\",\"man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468.png?v8\",\"man_artist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a8.png?v8\",\"man_astronaut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f680.png?v8\",\"man_beard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2642.png?v8\",\"man_cartwheeling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f938-2642.png?v8\",\"man_cook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f373.png?v8\",\"man_dancing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f57a.png?v8\",\"man_facepalming\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f926-2642.png?v8\",\"man_factory_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3ed.png?v8\",\"man_farmer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f33e.png?v8\",\"man_feeding_baby\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f37c.png?v8\",\"man_firefighter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f692.png?v8\",\"man_health_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2695.png?v8\",\"man_in_manual_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bd.png?v8\",\"man_in_motorized_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bc.png?v8\",\"man_in_tuxedo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f935-2642.png?v8\",\"man_judge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2696.png?v8\",\"man_juggling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f939-2642.png?v8\",\"man_mechanic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f527.png?v8\",\"man_office_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bc.png?v8\",\"man_pilot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2708.png?v8\",\"man_playing_handball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2642.png?v8\",\"man_playing_water_polo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2642.png?v8\",\"man_scientist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f52c.png?v8\",\"man_shrugging\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f937-2642.png?v8\",\"man_singer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a4.png?v8\",\"man_student\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f393.png?v8\",\"man_teacher\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3eb.png?v8\",\"man_technologist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png?v8\",\"man_with_gua_pi_mao\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f472.png?v8\",\"man_with_probing_cane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9af.png?v8\",\"man_with_turban\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f473-2642.png?v8\",\"man_with_veil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f470-2642.png?v8\",\"mandarin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8\",\"mango\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96d.png?v8\",\"mans_shoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8\",\"mantelpiece_clock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f570.png?v8\",\"manual_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9bd.png?v8\",\"maple_leaf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f341.png?v8\",\"marshall_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ed.png?v8\",\"martial_arts_uniform\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94b.png?v8\",\"martinique\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f6.png?v8\",\"mask\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f637.png?v8\",\"massage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f486.png?v8\",\"massage_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f486-2642.png?v8\",\"massage_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f486-2640.png?v8\",\"mate\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c9.png?v8\",\"mauritania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f7.png?v8\",\"mauritius\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fa.png?v8\",\"mayotte\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1f9.png?v8\",\"meat_on_bone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f356.png?v8\",\"mechanic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f527.png?v8\",\"mechanical_arm\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9be.png?v8\",\"mechanical_leg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9bf.png?v8\",\"medal_military\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f396.png?v8\",\"medal_sports\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c5.png?v8\",\"medical_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/2695.png?v8\",\"mega\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e3.png?v8\",\"melon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f348.png?v8\",\"memo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8\",\"men_wrestling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2642.png?v8\",\"mending_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/2764-1fa79.png?v8\",\"menorah\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f54e.png?v8\",\"mens\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b9.png?v8\",\"mermaid\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2640.png?v8\",\"merman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2642.png?v8\",\"merperson\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dc.png?v8\",\"metal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f918.png?v8\",\"metro\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f687.png?v8\",\"mexico\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fd.png?v8\",\"microbe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a0.png?v8\",\"micronesia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f2.png?v8\",\"microphone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a4.png?v8\",\"microscope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52c.png?v8\",\"middle_finger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8\",\"military_helmet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa96.png?v8\",\"milk_glass\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95b.png?v8\",\"milky_way\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30c.png?v8\",\"minibus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f690.png?v8\",\"minidisc\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4bd.png?v8\",\"mirror\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9e.png?v8\",\"mobile_phone_off\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f4.png?v8\",\"moldova\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e9.png?v8\",\"monaco\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e8.png?v8\",\"money_mouth_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f911.png?v8\",\"money_with_wings\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b8.png?v8\",\"moneybag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png?v8\",\"mongolia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f3.png?v8\",\"monkey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f412.png?v8\",\"monkey_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f435.png?v8\",\"monocle_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d0.png?v8\",\"monorail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69d.png?v8\",\"montenegro\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ea.png?v8\",\"montserrat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f8.png?v8\",\"moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8\",\"moon_cake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96e.png?v8\",\"morocco\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e6.png?v8\",\"mortar_board\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f393.png?v8\",\"mosque\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f54c.png?v8\",\"mosquito\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99f.png?v8\",\"motor_boat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e5.png?v8\",\"motor_scooter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f5.png?v8\",\"motorcycle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cd.png?v8\",\"motorized_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9bc.png?v8\",\"motorway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e3.png?v8\",\"mount_fuji\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fb.png?v8\",\"mountain\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f0.png?v8\",\"mountain_bicyclist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b5.png?v8\",\"mountain_biking_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2642.png?v8\",\"mountain_biking_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2640.png?v8\",\"mountain_cableway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a0.png?v8\",\"mountain_railway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69e.png?v8\",\"mountain_snow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d4.png?v8\",\"mouse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42d.png?v8\",\"mouse2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f401.png?v8\",\"mouse_trap\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa4.png?v8\",\"movie_camera\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a5.png?v8\",\"moyai\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5ff.png?v8\",\"mozambique\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ff.png?v8\",\"mrs_claus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f936.png?v8\",\"muscle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4aa.png?v8\",\"mushroom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f344.png?v8\",\"musical_keyboard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b9.png?v8\",\"musical_note\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b5.png?v8\",\"musical_score\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3bc.png?v8\",\"mute\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f507.png?v8\",\"mx_claus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f384.png?v8\",\"myanmar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f2.png?v8\",\"nail_care\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f485.png?v8\",\"name_badge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4db.png?v8\",\"namibia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e6.png?v8\",\"national_park\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3de.png?v8\",\"nauru\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f7.png?v8\",\"nauseated_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f922.png?v8\",\"nazar_amulet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ff.png?v8\",\"neckbeard\":\"https://github.githubassets.com/images/icons/emoji/neckbeard.png?v8\",\"necktie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f454.png?v8\",\"negative_squared_cross_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/274e.png?v8\",\"nepal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f5.png?v8\",\"nerd_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f913.png?v8\",\"nesting_dolls\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa86.png?v8\",\"netherlands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f1.png?v8\",\"neutral_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f610.png?v8\",\"new\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f195.png?v8\",\"new_caledonia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e8.png?v8\",\"new_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f311.png?v8\",\"new_moon_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31a.png?v8\",\"new_zealand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ff.png?v8\",\"newspaper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f0.png?v8\",\"newspaper_roll\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5de.png?v8\",\"next_track_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ed.png?v8\",\"ng\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f196.png?v8\",\"ng_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8\",\"ng_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8\",\"nicaragua\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ee.png?v8\",\"niger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ea.png?v8\",\"nigeria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ec.png?v8\",\"night_with_stars\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f303.png?v8\",\"nine\":\"https://github.githubassets.com/images/icons/emoji/unicode/0039-20e3.png?v8\",\"ninja\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f977.png?v8\",\"niue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1fa.png?v8\",\"no_bell\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f515.png?v8\",\"no_bicycles\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b3.png?v8\",\"no_entry\":\"https://github.githubassets.com/images/icons/emoji/unicode/26d4.png?v8\",\"no_entry_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ab.png?v8\",\"no_good\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645.png?v8\",\"no_good_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8\",\"no_good_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8\",\"no_mobile_phones\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f5.png?v8\",\"no_mouth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f636.png?v8\",\"no_pedestrians\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b7.png?v8\",\"no_smoking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ad.png?v8\",\"non-potable_water\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b1.png?v8\",\"norfolk_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1eb.png?v8\",\"north_korea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f5.png?v8\",\"northern_mariana_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f5.png?v8\",\"norway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f4.png?v8\",\"nose\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f443.png?v8\",\"notebook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d3.png?v8\",\"notebook_with_decorative_cover\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d4.png?v8\",\"notes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b6.png?v8\",\"nut_and_bolt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f529.png?v8\",\"o\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b55.png?v8\",\"o2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f17e.png?v8\",\"ocean\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30a.png?v8\",\"octocat\":\"https://github.githubassets.com/images/icons/emoji/octocat.png?v8\",\"octopus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f419.png?v8\",\"oden\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f362.png?v8\",\"office\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e2.png?v8\",\"office_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bc.png?v8\",\"oil_drum\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e2.png?v8\",\"ok\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f197.png?v8\",\"ok_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44c.png?v8\",\"ok_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f646-2642.png?v8\",\"ok_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f646.png?v8\",\"ok_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f646-2640.png?v8\",\"old_key\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5dd.png?v8\",\"older_adult\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d3.png?v8\",\"older_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f474.png?v8\",\"older_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f475.png?v8\",\"olive\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad2.png?v8\",\"om\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f549.png?v8\",\"oman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f4-1f1f2.png?v8\",\"on\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51b.png?v8\",\"oncoming_automobile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f698.png?v8\",\"oncoming_bus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68d.png?v8\",\"oncoming_police_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f694.png?v8\",\"oncoming_taxi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f696.png?v8\",\"one\":\"https://github.githubassets.com/images/icons/emoji/unicode/0031-20e3.png?v8\",\"one_piece_swimsuit\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa71.png?v8\",\"onion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c5.png?v8\",\"open_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8\",\"open_file_folder\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c2.png?v8\",\"open_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f450.png?v8\",\"open_mouth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62e.png?v8\",\"open_umbrella\":\"https://github.githubassets.com/images/icons/emoji/unicode/2602.png?v8\",\"ophiuchus\":\"https://github.githubassets.com/images/icons/emoji/unicode/26ce.png?v8\",\"orange\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8\",\"orange_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d9.png?v8\",\"orange_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e0.png?v8\",\"orange_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e1.png?v8\",\"orange_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e7.png?v8\",\"orangutan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a7.png?v8\",\"orthodox_cross\":\"https://github.githubassets.com/images/icons/emoji/unicode/2626.png?v8\",\"otter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a6.png?v8\",\"outbox_tray\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e4.png?v8\",\"owl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f989.png?v8\",\"ox\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f402.png?v8\",\"oyster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9aa.png?v8\",\"package\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png?v8\",\"page_facing_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c4.png?v8\",\"page_with_curl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c3.png?v8\",\"pager\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4df.png?v8\",\"paintbrush\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f58c.png?v8\",\"pakistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f0.png?v8\",\"palau\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fc.png?v8\",\"palestinian_territories\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f8.png?v8\",\"palm_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f334.png?v8\",\"palms_up_together\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f932.png?v8\",\"panama\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1e6.png?v8\",\"pancakes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95e.png?v8\",\"panda_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43c.png?v8\",\"paperclip\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ce.png?v8\",\"paperclips\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f587.png?v8\",\"papua_new_guinea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ec.png?v8\",\"parachute\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa82.png?v8\",\"paraguay\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fe.png?v8\",\"parasol_on_ground\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f1.png?v8\",\"parking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f17f.png?v8\",\"parrot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99c.png?v8\",\"part_alternation_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/303d.png?v8\",\"partly_sunny\":\"https://github.githubassets.com/images/icons/emoji/unicode/26c5.png?v8\",\"partying_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f973.png?v8\",\"passenger_ship\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f3.png?v8\",\"passport_control\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c2.png?v8\",\"pause_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f8.png?v8\",\"paw_prints\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8\",\"peace_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/262e.png?v8\",\"peach\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f351.png?v8\",\"peacock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99a.png?v8\",\"peanuts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95c.png?v8\",\"pear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f350.png?v8\",\"pen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f58a.png?v8\",\"pencil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8\",\"pencil2\":\"https://github.githubassets.com/images/icons/emoji/unicode/270f.png?v8\",\"penguin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f427.png?v8\",\"pensive\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f614.png?v8\",\"people_holding_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f91d-1f9d1.png?v8\",\"people_hugging\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fac2.png?v8\",\"performing_arts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png?v8\",\"persevere\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f623.png?v8\",\"person_bald\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b2.png?v8\",\"person_curly_hair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b1.png?v8\",\"person_feeding_baby\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f37c.png?v8\",\"person_fencing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93a.png?v8\",\"person_in_manual_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bd.png?v8\",\"person_in_motorized_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bc.png?v8\",\"person_in_tuxedo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f935.png?v8\",\"person_red_hair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b0.png?v8\",\"person_white_hair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b3.png?v8\",\"person_with_probing_cane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9af.png?v8\",\"person_with_turban\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f473.png?v8\",\"person_with_veil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f470.png?v8\",\"peru\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ea.png?v8\",\"petri_dish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9eb.png?v8\",\"philippines\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ed.png?v8\",\"phone\":\"https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8\",\"pick\":\"https://github.githubassets.com/images/icons/emoji/unicode/26cf.png?v8\",\"pickup_truck\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6fb.png?v8\",\"pie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f967.png?v8\",\"pig\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f437.png?v8\",\"pig2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f416.png?v8\",\"pig_nose\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43d.png?v8\",\"pill\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png?v8\",\"pilot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2708.png?v8\",\"pinata\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa85.png?v8\",\"pinched_fingers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f90c.png?v8\",\"pinching_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f90f.png?v8\",\"pineapple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34d.png?v8\",\"ping_pong\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d3.png?v8\",\"pirate_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-2620.png?v8\",\"pisces\":\"https://github.githubassets.com/images/icons/emoji/unicode/2653.png?v8\",\"pitcairn_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f3.png?v8\",\"pizza\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f355.png?v8\",\"placard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa7.png?v8\",\"place_of_worship\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d0.png?v8\",\"plate_with_cutlery\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37d.png?v8\",\"play_or_pause_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ef.png?v8\",\"pleading_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97a.png?v8\",\"plunger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa0.png?v8\",\"point_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f447.png?v8\",\"point_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f448.png?v8\",\"point_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f449.png?v8\",\"point_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/261d.png?v8\",\"point_up_2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f446.png?v8\",\"poland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f1.png?v8\",\"polar_bear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43b-2744.png?v8\",\"police_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f693.png?v8\",\"police_officer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8\",\"policeman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2642.png?v8\",\"policewoman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2640.png?v8\",\"poodle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f429.png?v8\",\"poop\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8\",\"popcorn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37f.png?v8\",\"portugal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f9.png?v8\",\"post_office\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e3.png?v8\",\"postal_horn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ef.png?v8\",\"postbox\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ee.png?v8\",\"potable_water\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b0.png?v8\",\"potato\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f954.png?v8\",\"potted_plant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab4.png?v8\",\"pouch\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45d.png?v8\",\"poultry_leg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f357.png?v8\",\"pound\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b7.png?v8\",\"pout\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8\",\"pouting_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63e.png?v8\",\"pouting_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64e.png?v8\",\"pouting_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2642.png?v8\",\"pouting_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2640.png?v8\",\"pray\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png?v8\",\"prayer_beads\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ff.png?v8\",\"pregnant_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f930.png?v8\",\"pretzel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f968.png?v8\",\"previous_track_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ee.png?v8\",\"prince\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f934.png?v8\",\"princess\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f478.png?v8\",\"printer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5a8.png?v8\",\"probing_cane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9af.png?v8\",\"puerto_rico\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f7.png?v8\",\"punch\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8\",\"purple_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e3.png?v8\",\"purple_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49c.png?v8\",\"purple_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7ea.png?v8\",\"purse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45b.png?v8\",\"pushpin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4cc.png?v8\",\"put_litter_in_its_place\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ae.png?v8\",\"qatar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f6-1f1e6.png?v8\",\"question\":\"https://github.githubassets.com/images/icons/emoji/unicode/2753.png?v8\",\"rabbit\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f430.png?v8\",\"rabbit2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f407.png?v8\",\"raccoon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99d.png?v8\",\"racehorse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40e.png?v8\",\"racing_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ce.png?v8\",\"radio\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4fb.png?v8\",\"radio_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f518.png?v8\",\"radioactive\":\"https://github.githubassets.com/images/icons/emoji/unicode/2622.png?v8\",\"rage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8\",\"rage1\":\"https://github.githubassets.com/images/icons/emoji/rage1.png?v8\",\"rage2\":\"https://github.githubassets.com/images/icons/emoji/rage2.png?v8\",\"rage3\":\"https://github.githubassets.com/images/icons/emoji/rage3.png?v8\",\"rage4\":\"https://github.githubassets.com/images/icons/emoji/rage4.png?v8\",\"railway_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f683.png?v8\",\"railway_track\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e4.png?v8\",\"rainbow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f308.png?v8\",\"rainbow_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-1f308.png?v8\",\"raised_back_of_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91a.png?v8\",\"raised_eyebrow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f928.png?v8\",\"raised_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8\",\"raised_hand_with_fingers_splayed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f590.png?v8\",\"raised_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64c.png?v8\",\"raising_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64b.png?v8\",\"raising_hand_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2642.png?v8\",\"raising_hand_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2640.png?v8\",\"ram\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40f.png?v8\",\"ramen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35c.png?v8\",\"rat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f400.png?v8\",\"razor\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa92.png?v8\",\"receipt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fe.png?v8\",\"record_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23fa.png?v8\",\"recycle\":\"https://github.githubassets.com/images/icons/emoji/unicode/267b.png?v8\",\"red_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8\",\"red_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f534.png?v8\",\"red_envelope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e7.png?v8\",\"red_haired_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b0.png?v8\",\"red_haired_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b0.png?v8\",\"red_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e5.png?v8\",\"registered\":\"https://github.githubassets.com/images/icons/emoji/unicode/00ae.png?v8\",\"relaxed\":\"https://github.githubassets.com/images/icons/emoji/unicode/263a.png?v8\",\"relieved\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60c.png?v8\",\"reminder_ribbon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f397.png?v8\",\"repeat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f501.png?v8\",\"repeat_one\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f502.png?v8\",\"rescue_worker_helmet\":\"https://github.githubassets.com/images/icons/emoji/unicode/26d1.png?v8\",\"restroom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6bb.png?v8\",\"reunion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1ea.png?v8\",\"revolving_hearts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49e.png?v8\",\"rewind\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ea.png?v8\",\"rhinoceros\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98f.png?v8\",\"ribbon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f380.png?v8\",\"rice\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35a.png?v8\",\"rice_ball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f359.png?v8\",\"rice_cracker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f358.png?v8\",\"rice_scene\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f391.png?v8\",\"right_anger_bubble\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5ef.png?v8\",\"ring\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48d.png?v8\",\"ringed_planet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa90.png?v8\",\"robot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f916.png?v8\",\"rock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa8.png?v8\",\"rocket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f680.png?v8\",\"rofl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f923.png?v8\",\"roll_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f644.png?v8\",\"roll_of_paper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fb.png?v8\",\"roller_coaster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a2.png?v8\",\"roller_skate\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6fc.png?v8\",\"romania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f4.png?v8\",\"rooster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f413.png?v8\",\"rose\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f339.png?v8\",\"rosette\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f5.png?v8\",\"rotating_light\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a8.png?v8\",\"round_pushpin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4cd.png?v8\",\"rowboat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a3.png?v8\",\"rowing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2642.png?v8\",\"rowing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2640.png?v8\",\"ru\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8\",\"rugby_football\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c9.png?v8\",\"runner\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8\",\"running\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8\",\"running_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2642.png?v8\",\"running_shirt_with_sash\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3bd.png?v8\",\"running_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2640.png?v8\",\"rwanda\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fc.png?v8\",\"sa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f202.png?v8\",\"safety_pin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f7.png?v8\",\"safety_vest\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ba.png?v8\",\"sagittarius\":\"https://github.githubassets.com/images/icons/emoji/unicode/2650.png?v8\",\"sailboat\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8\",\"sake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f376.png?v8\",\"salt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c2.png?v8\",\"samoa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1f8.png?v8\",\"san_marino\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f2.png?v8\",\"sandal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f461.png?v8\",\"sandwich\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96a.png?v8\",\"santa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f385.png?v8\",\"sao_tome_principe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f9.png?v8\",\"sari\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97b.png?v8\",\"sassy_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8\",\"sassy_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8\",\"satellite\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e1.png?v8\",\"satisfied\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8\",\"saudi_arabia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e6.png?v8\",\"sauna_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2642.png?v8\",\"sauna_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d6.png?v8\",\"sauna_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2640.png?v8\",\"sauropod\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f995.png?v8\",\"saxophone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b7.png?v8\",\"scarf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e3.png?v8\",\"school\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3eb.png?v8\",\"school_satchel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f392.png?v8\",\"scientist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f52c.png?v8\",\"scissors\":\"https://github.githubassets.com/images/icons/emoji/unicode/2702.png?v8\",\"scorpion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f982.png?v8\",\"scorpius\":\"https://github.githubassets.com/images/icons/emoji/unicode/264f.png?v8\",\"scotland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0073-e0063-e0074-e007f.png?v8\",\"scream\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f631.png?v8\",\"scream_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f640.png?v8\",\"screwdriver\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9b.png?v8\",\"scroll\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png?v8\",\"seal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ad.png?v8\",\"seat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ba.png?v8\",\"secret\":\"https://github.githubassets.com/images/icons/emoji/unicode/3299.png?v8\",\"see_no_evil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f648.png?v8\",\"seedling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f331.png?v8\",\"selfie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f933.png?v8\",\"senegal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f3.png?v8\",\"serbia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f8.png?v8\",\"service_dog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f415-1f9ba.png?v8\",\"seven\":\"https://github.githubassets.com/images/icons/emoji/unicode/0037-20e3.png?v8\",\"sewing_needle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa1.png?v8\",\"seychelles\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e8.png?v8\",\"shallow_pan_of_food\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f958.png?v8\",\"shamrock\":\"https://github.githubassets.com/images/icons/emoji/unicode/2618.png?v8\",\"shark\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f988.png?v8\",\"shaved_ice\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f367.png?v8\",\"sheep\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f411.png?v8\",\"shell\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41a.png?v8\",\"shield\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png?v8\",\"shinto_shrine\":\"https://github.githubassets.com/images/icons/emoji/unicode/26e9.png?v8\",\"ship\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a2.png?v8\",\"shipit\":\"https://github.githubassets.com/images/icons/emoji/shipit.png?v8\",\"shirt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8\",\"shoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8\",\"shopping\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6cd.png?v8\",\"shopping_cart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d2.png?v8\",\"shorts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa73.png?v8\",\"shower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6bf.png?v8\",\"shrimp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f990.png?v8\",\"shrug\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f937.png?v8\",\"shushing_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92b.png?v8\",\"sierra_leone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f1.png?v8\",\"signal_strength\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f6.png?v8\",\"singapore\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ec.png?v8\",\"singer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a4.png?v8\",\"sint_maarten\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fd.png?v8\",\"six\":\"https://github.githubassets.com/images/icons/emoji/unicode/0036-20e3.png?v8\",\"six_pointed_star\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52f.png?v8\",\"skateboard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f9.png?v8\",\"ski\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3bf.png?v8\",\"skier\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f7.png?v8\",\"skull\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f480.png?v8\",\"skull_and_crossbones\":\"https://github.githubassets.com/images/icons/emoji/unicode/2620.png?v8\",\"skunk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a8.png?v8\",\"sled\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f7.png?v8\",\"sleeping\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f634.png?v8\",\"sleeping_bed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6cc.png?v8\",\"sleepy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62a.png?v8\",\"slightly_frowning_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f641.png?v8\",\"slightly_smiling_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f642.png?v8\",\"slot_machine\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b0.png?v8\",\"sloth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a5.png?v8\",\"slovakia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f0.png?v8\",\"slovenia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ee.png?v8\",\"small_airplane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e9.png?v8\",\"small_blue_diamond\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f539.png?v8\",\"small_orange_diamond\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f538.png?v8\",\"small_red_triangle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f53a.png?v8\",\"small_red_triangle_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f53b.png?v8\",\"smile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8\",\"smile_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f638.png?v8\",\"smiley\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f603.png?v8\",\"smiley_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63a.png?v8\",\"smiling_face_with_tear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f972.png?v8\",\"smiling_face_with_three_hearts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f970.png?v8\",\"smiling_imp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f608.png?v8\",\"smirk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60f.png?v8\",\"smirk_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63c.png?v8\",\"smoking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ac.png?v8\",\"snail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40c.png?v8\",\"snake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png?v8\",\"sneezing_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f927.png?v8\",\"snowboarder\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c2.png?v8\",\"snowflake\":\"https://github.githubassets.com/images/icons/emoji/unicode/2744.png?v8\",\"snowman\":\"https://github.githubassets.com/images/icons/emoji/unicode/26c4.png?v8\",\"snowman_with_snow\":\"https://github.githubassets.com/images/icons/emoji/unicode/2603.png?v8\",\"soap\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fc.png?v8\",\"sob\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62d.png?v8\",\"soccer\":\"https://github.githubassets.com/images/icons/emoji/unicode/26bd.png?v8\",\"socks\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e6.png?v8\",\"softball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94e.png?v8\",\"solomon_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e7.png?v8\",\"somalia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f4.png?v8\",\"soon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png?v8\",\"sos\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f198.png?v8\",\"sound\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f509.png?v8\",\"south_africa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1e6.png?v8\",\"south_georgia_south_sandwich_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f8.png?v8\",\"south_sudan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f8.png?v8\",\"space_invader\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png?v8\",\"spades\":\"https://github.githubassets.com/images/icons/emoji/unicode/2660.png?v8\",\"spaghetti\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35d.png?v8\",\"sparkle\":\"https://github.githubassets.com/images/icons/emoji/unicode/2747.png?v8\",\"sparkler\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f387.png?v8\",\"sparkles\":\"https://github.githubassets.com/images/icons/emoji/unicode/2728.png?v8\",\"sparkling_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f496.png?v8\",\"speak_no_evil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64a.png?v8\",\"speaker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f508.png?v8\",\"speaking_head\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5e3.png?v8\",\"speech_balloon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ac.png?v8\",\"speedboat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a4.png?v8\",\"spider\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f577.png?v8\",\"spider_web\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f578.png?v8\",\"spiral_calendar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5d3.png?v8\",\"spiral_notepad\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5d2.png?v8\",\"sponge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fd.png?v8\",\"spoon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f944.png?v8\",\"squid\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f991.png?v8\",\"sri_lanka\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f0.png?v8\",\"st_barthelemy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f1.png?v8\",\"st_helena\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ed.png?v8\",\"st_kitts_nevis\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f3.png?v8\",\"st_lucia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e8.png?v8\",\"st_martin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1eb.png?v8\",\"st_pierre_miquelon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f2.png?v8\",\"st_vincent_grenadines\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e8.png?v8\",\"stadium\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3df.png?v8\",\"standing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2642.png?v8\",\"standing_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cd.png?v8\",\"standing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2640.png?v8\",\"star\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b50.png?v8\",\"star2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png?v8\",\"star_and_crescent\":\"https://github.githubassets.com/images/icons/emoji/unicode/262a.png?v8\",\"star_of_david\":\"https://github.githubassets.com/images/icons/emoji/unicode/2721.png?v8\",\"star_struck\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f929.png?v8\",\"stars\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f320.png?v8\",\"station\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f689.png?v8\",\"statue_of_liberty\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fd.png?v8\",\"steam_locomotive\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f682.png?v8\",\"stethoscope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa7a.png?v8\",\"stew\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f372.png?v8\",\"stop_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f9.png?v8\",\"stop_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d1.png?v8\",\"stopwatch\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f1.png?v8\",\"straight_ruler\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4cf.png?v8\",\"strawberry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f353.png?v8\",\"stuck_out_tongue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61b.png?v8\",\"stuck_out_tongue_closed_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61d.png?v8\",\"stuck_out_tongue_winking_eye\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61c.png?v8\",\"student\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f393.png?v8\",\"studio_microphone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f399.png?v8\",\"stuffed_flatbread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f959.png?v8\",\"sudan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e9.png?v8\",\"sun_behind_large_cloud\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f325.png?v8\",\"sun_behind_rain_cloud\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f326.png?v8\",\"sun_behind_small_cloud\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f324.png?v8\",\"sun_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31e.png?v8\",\"sunflower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33b.png?v8\",\"sunglasses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60e.png?v8\",\"sunny\":\"https://github.githubassets.com/images/icons/emoji/unicode/2600.png?v8\",\"sunrise\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f305.png?v8\",\"sunrise_over_mountains\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f304.png?v8\",\"superhero\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b8.png?v8\",\"superhero_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2642.png?v8\",\"superhero_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2640.png?v8\",\"supervillain\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b9.png?v8\",\"supervillain_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2642.png?v8\",\"supervillain_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2640.png?v8\",\"surfer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png?v8\",\"surfing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2642.png?v8\",\"surfing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2640.png?v8\",\"suriname\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f7.png?v8\",\"sushi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f363.png?v8\",\"suspect\":\"https://github.githubassets.com/images/icons/emoji/suspect.png?v8\",\"suspension_railway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69f.png?v8\",\"svalbard_jan_mayen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ef.png?v8\",\"swan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a2.png?v8\",\"swaziland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ff.png?v8\",\"sweat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f613.png?v8\",\"sweat_drops\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a6.png?v8\",\"sweat_smile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f605.png?v8\",\"sweden\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ea.png?v8\",\"sweet_potato\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f360.png?v8\",\"swim_brief\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa72.png?v8\",\"swimmer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ca.png?v8\",\"swimming_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2642.png?v8\",\"swimming_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2640.png?v8\",\"switzerland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ed.png?v8\",\"symbols\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f523.png?v8\",\"synagogue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f54d.png?v8\",\"syria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fe.png?v8\",\"syringe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f489.png?v8\",\"t-rex\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f996.png?v8\",\"taco\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32e.png?v8\",\"tada\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f389.png?v8\",\"taiwan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fc.png?v8\",\"tajikistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ef.png?v8\",\"takeout_box\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f961.png?v8\",\"tamale\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad4.png?v8\",\"tanabata_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38b.png?v8\",\"tangerine\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8\",\"tanzania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ff.png?v8\",\"taurus\":\"https://github.githubassets.com/images/icons/emoji/unicode/2649.png?v8\",\"taxi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f695.png?v8\",\"tea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f375.png?v8\",\"teacher\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3eb.png?v8\",\"teapot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad6.png?v8\",\"technologist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bb.png?v8\",\"teddy_bear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f8.png?v8\",\"telephone\":\"https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8\",\"telephone_receiver\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4de.png?v8\",\"telescope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52d.png?v8\",\"tennis\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3be.png?v8\",\"tent\":\"https://github.githubassets.com/images/icons/emoji/unicode/26fa.png?v8\",\"test_tube\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ea.png?v8\",\"thailand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ed.png?v8\",\"thermometer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f321.png?v8\",\"thinking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f914.png?v8\",\"thong_sandal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa74.png?v8\",\"thought_balloon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ad.png?v8\",\"thread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f5.png?v8\",\"three\":\"https://github.githubassets.com/images/icons/emoji/unicode/0033-20e3.png?v8\",\"thumbsdown\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8\",\"thumbsup\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8\",\"ticket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ab.png?v8\",\"tickets\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f39f.png?v8\",\"tiger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png?v8\",\"tiger2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f405.png?v8\",\"timer_clock\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f2.png?v8\",\"timor_leste\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f1.png?v8\",\"tipping_hand_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8\",\"tipping_hand_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8\",\"tipping_hand_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8\",\"tired_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62b.png?v8\",\"tm\":\"https://github.githubassets.com/images/icons/emoji/unicode/2122.png?v8\",\"togo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ec.png?v8\",\"toilet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6bd.png?v8\",\"tokelau\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f0.png?v8\",\"tokyo_tower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fc.png?v8\",\"tomato\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f345.png?v8\",\"tonga\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f4.png?v8\",\"tongue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f445.png?v8\",\"toolbox\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f0.png?v8\",\"tooth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b7.png?v8\",\"toothbrush\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa5.png?v8\",\"top\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51d.png?v8\",\"tophat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a9.png?v8\",\"tornado\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32a.png?v8\",\"tr\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f7.png?v8\",\"trackball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5b2.png?v8\",\"tractor\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69c.png?v8\",\"traffic_light\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a5.png?v8\",\"train\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68b.png?v8\",\"train2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f686.png?v8\",\"tram\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68a.png?v8\",\"transgender_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-26a7.png?v8\",\"transgender_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/26a7.png?v8\",\"triangular_flag_on_post\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a9.png?v8\",\"triangular_ruler\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d0.png?v8\",\"trident\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f531.png?v8\",\"trinidad_tobago\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f9.png?v8\",\"tristan_da_cunha\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e6.png?v8\",\"triumph\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f624.png?v8\",\"trolleybus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68e.png?v8\",\"trollface\":\"https://github.githubassets.com/images/icons/emoji/trollface.png?v8\",\"trophy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png?v8\",\"tropical_drink\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f379.png?v8\",\"tropical_fish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f420.png?v8\",\"truck\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69a.png?v8\",\"trumpet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ba.png?v8\",\"tshirt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8\",\"tulip\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f337.png?v8\",\"tumbler_glass\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f943.png?v8\",\"tunisia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f3.png?v8\",\"turkey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f983.png?v8\",\"turkmenistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f2.png?v8\",\"turks_caicos_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e8.png?v8\",\"turtle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f422.png?v8\",\"tuvalu\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fb.png?v8\",\"tv\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4fa.png?v8\",\"twisted_rightwards_arrows\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f500.png?v8\",\"two\":\"https://github.githubassets.com/images/icons/emoji/unicode/0032-20e3.png?v8\",\"two_hearts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f495.png?v8\",\"two_men_holding_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46c.png?v8\",\"two_women_holding_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46d.png?v8\",\"u5272\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f239.png?v8\",\"u5408\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f234.png?v8\",\"u55b6\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f23a.png?v8\",\"u6307\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f22f.png?v8\",\"u6708\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f237.png?v8\",\"u6709\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f236.png?v8\",\"u6e80\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f235.png?v8\",\"u7121\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f21a.png?v8\",\"u7533\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f238.png?v8\",\"u7981\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f232.png?v8\",\"u7a7a\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f233.png?v8\",\"uganda\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ec.png?v8\",\"uk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8\",\"ukraine\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1e6.png?v8\",\"umbrella\":\"https://github.githubassets.com/images/icons/emoji/unicode/2614.png?v8\",\"unamused\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f612.png?v8\",\"underage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51e.png?v8\",\"unicorn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f984.png?v8\",\"united_arab_emirates\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ea.png?v8\",\"united_nations\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f3.png?v8\",\"unlock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f513.png?v8\",\"up\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f199.png?v8\",\"upside_down_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f643.png?v8\",\"uruguay\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1fe.png?v8\",\"us\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f8.png?v8\",\"us_outlying_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f2.png?v8\",\"us_virgin_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ee.png?v8\",\"uzbekistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ff.png?v8\",\"v\":\"https://github.githubassets.com/images/icons/emoji/unicode/270c.png?v8\",\"vampire\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9db.png?v8\",\"vampire_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2642.png?v8\",\"vampire_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2640.png?v8\",\"vanuatu\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1fa.png?v8\",\"vatican_city\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e6.png?v8\",\"venezuela\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ea.png?v8\",\"vertical_traffic_light\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a6.png?v8\",\"vhs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4fc.png?v8\",\"vibration_mode\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f3.png?v8\",\"video_camera\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f9.png?v8\",\"video_game\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ae.png?v8\",\"vietnam\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1f3.png?v8\",\"violin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3bb.png?v8\",\"virgo\":\"https://github.githubassets.com/images/icons/emoji/unicode/264d.png?v8\",\"volcano\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30b.png?v8\",\"volleyball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d0.png?v8\",\"vomiting_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92e.png?v8\",\"vs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f19a.png?v8\",\"vulcan_salute\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f596.png?v8\",\"waffle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c7.png?v8\",\"wales\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0077-e006c-e0073-e007f.png?v8\",\"walking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b6.png?v8\",\"walking_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2642.png?v8\",\"walking_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2640.png?v8\",\"wallis_futuna\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1eb.png?v8\",\"waning_crescent_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f318.png?v8\",\"waning_gibbous_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f316.png?v8\",\"warning\":\"https://github.githubassets.com/images/icons/emoji/unicode/26a0.png?v8\",\"wastebasket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5d1.png?v8\",\"watch\":\"https://github.githubassets.com/images/icons/emoji/unicode/231a.png?v8\",\"water_buffalo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f403.png?v8\",\"water_polo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93d.png?v8\",\"watermelon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f349.png?v8\",\"wave\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png?v8\",\"wavy_dash\":\"https://github.githubassets.com/images/icons/emoji/unicode/3030.png?v8\",\"waxing_crescent_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f312.png?v8\",\"waxing_gibbous_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8\",\"wc\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6be.png?v8\",\"weary\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f629.png?v8\",\"wedding\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f492.png?v8\",\"weight_lifting\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cb.png?v8\",\"weight_lifting_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2642.png?v8\",\"weight_lifting_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2640.png?v8\",\"western_sahara\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ed.png?v8\",\"whale\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f433.png?v8\",\"whale2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40b.png?v8\",\"wheel_of_dharma\":\"https://github.githubassets.com/images/icons/emoji/unicode/2638.png?v8\",\"wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/267f.png?v8\",\"white_check_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/2705.png?v8\",\"white_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/26aa.png?v8\",\"white_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f3.png?v8\",\"white_flower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ae.png?v8\",\"white_haired_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b3.png?v8\",\"white_haired_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b3.png?v8\",\"white_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f90d.png?v8\",\"white_large_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b1c.png?v8\",\"white_medium_small_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25fd.png?v8\",\"white_medium_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25fb.png?v8\",\"white_small_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25ab.png?v8\",\"white_square_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f533.png?v8\",\"wilted_flower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f940.png?v8\",\"wind_chime\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f390.png?v8\",\"wind_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32c.png?v8\",\"window\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9f.png?v8\",\"wine_glass\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f377.png?v8\",\"wink\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f609.png?v8\",\"wolf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43a.png?v8\",\"woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469.png?v8\",\"woman_artist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a8.png?v8\",\"woman_astronaut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f680.png?v8\",\"woman_beard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2640.png?v8\",\"woman_cartwheeling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f938-2640.png?v8\",\"woman_cook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f373.png?v8\",\"woman_dancing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8\",\"woman_facepalming\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f926-2640.png?v8\",\"woman_factory_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3ed.png?v8\",\"woman_farmer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f33e.png?v8\",\"woman_feeding_baby\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f37c.png?v8\",\"woman_firefighter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f692.png?v8\",\"woman_health_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2695.png?v8\",\"woman_in_manual_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bd.png?v8\",\"woman_in_motorized_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bc.png?v8\",\"woman_in_tuxedo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f935-2640.png?v8\",\"woman_judge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2696.png?v8\",\"woman_juggling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f939-2640.png?v8\",\"woman_mechanic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f527.png?v8\",\"woman_office_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bc.png?v8\",\"woman_pilot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2708.png?v8\",\"woman_playing_handball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2640.png?v8\",\"woman_playing_water_polo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2640.png?v8\",\"woman_scientist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f52c.png?v8\",\"woman_shrugging\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f937-2640.png?v8\",\"woman_singer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a4.png?v8\",\"woman_student\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f393.png?v8\",\"woman_teacher\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3eb.png?v8\",\"woman_technologist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bb.png?v8\",\"woman_with_headscarf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d5.png?v8\",\"woman_with_probing_cane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9af.png?v8\",\"woman_with_turban\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f473-2640.png?v8\",\"woman_with_veil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8\",\"womans_clothes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45a.png?v8\",\"womans_hat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f452.png?v8\",\"women_wrestling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2640.png?v8\",\"womens\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ba.png?v8\",\"wood\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab5.png?v8\",\"woozy_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f974.png?v8\",\"world_map\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fa.png?v8\",\"worm\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab1.png?v8\",\"worried\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61f.png?v8\",\"wrench\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f527.png?v8\",\"wrestling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93c.png?v8\",\"writing_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/270d.png?v8\",\"x\":\"https://github.githubassets.com/images/icons/emoji/unicode/274c.png?v8\",\"yarn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f6.png?v8\",\"yawning_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f971.png?v8\",\"yellow_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e1.png?v8\",\"yellow_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49b.png?v8\",\"yellow_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e8.png?v8\",\"yemen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1ea.png?v8\",\"yen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b4.png?v8\",\"yin_yang\":\"https://github.githubassets.com/images/icons/emoji/unicode/262f.png?v8\",\"yo_yo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa80.png?v8\",\"yum\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png?v8\",\"zambia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1f2.png?v8\",\"zany_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92a.png?v8\",\"zap\":\"https://github.githubassets.com/images/icons/emoji/unicode/26a1.png?v8\",\"zebra\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f993.png?v8\",\"zero\":\"https://github.githubassets.com/images/icons/emoji/unicode/0030-20e3.png?v8\",\"zimbabwe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1fc.png?v8\",\"zipper_mouth_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f910.png?v8\",\"zombie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9df.png?v8\",\"zombie_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8\",\"zombie_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8\",\"zzz\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Add an authorized SSH key", - "scope": "enterpriseAdmin", - "id": "addAuthorizedSshKey", - "method": "POST", - "url": "{origin}/setup/api/settings/authorized-keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#add-an-authorized-ssh-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "authorized_key", - "description": "The public SSH key.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a GitHub license", - "scope": "enterpriseAdmin", - "id": "createEnterpriseServerLicense", - "method": "POST", - "url": "{origin}/setup/api/start", - "isDeprecated": false, - "deprecationDate": null, - "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#create-a-github-enterprise-server-license", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "license", - "description": "The content of your _.ghl_ license file.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "password", - "description": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "settings", - "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-settings).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 202, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Create a global webhook", - "scope": "enterpriseAdmin", - "id": "createGlobalWebhook", - "method": "POST", - "url": "/admin/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#create-a-global-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "Must be passed as \"web\".", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers) header.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "events", - "description": "The [events](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\",\"user\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create an impersonation OAuth token", - "scope": "enterpriseAdmin", - "id": "createImpersonationOAuthToken", - "method": "POST", - "url": "/admin/users/{username}/authorizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#create-an-impersonation-oauth-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "scopes", - "description": "A list of [scopes](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response when getting an existing impersonation OAuth token", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"expires_at\":\"2011-10-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}" - } - ] - }, - { - "code": 201, - "description": "Response when creating a new impersonation OAuth token", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"expires_at\":\"2011-10-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create an organization", - "scope": "enterpriseAdmin", - "id": "createOrg", - "method": "POST", - "url": "/admin/organizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#create-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "login", - "description": "The organization's username.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "admin", - "description": "The login of the user who will manage this organization.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "profile_name", - "description": "The organization's display name.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "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\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "createPreReceiveEnvironment", - "method": "POST", - "url": "/admin/pre-receive-environments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#create-a-pre-receive-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "The new pre-receive environment's name.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "image_url", - "description": "URL from which to download a tarball of this environment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":null,\"message\":null}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a pre-receive hook", - "scope": "enterpriseAdmin", - "id": "createPreReceiveHook", - "method": "POST", - "url": "/admin/pre-receive-hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#create-a-pre-receive-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "The name of the hook.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script", - "description": "The script that the hook runs.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script_repository", - "description": "The GitHub repository where the script is kept.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script_repository.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "The pre-receive environment where the script is executed.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforcement", - "description": "The state of enforcement for this hook. default: `disabled`", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_downstream_configuration", - "description": "Whether enforcement can be overridden at the org or repo level. default: `false`", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a user", - "scope": "enterpriseAdmin", - "id": "createUser", - "method": "POST", - "url": "/admin/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#create-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "login", - "description": "The user's username.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "email", - "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.2/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a global webhook", - "scope": "enterpriseAdmin", - "id": "deleteGlobalWebhook", - "method": "DELETE", - "url": "/admin/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#delete-a-global-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an impersonation OAuth token", - "scope": "enterpriseAdmin", - "id": "deleteImpersonationOAuthToken", - "method": "DELETE", - "url": "/admin/users/{username}/authorizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#delete-an-impersonation-oauth-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a personal access token", - "scope": "enterpriseAdmin", - "id": "deletePersonalAccessToken", - "method": "DELETE", - "url": "/admin/tokens/{token_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#delete-a-personal-access-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "token_id", - "description": "The unique identifier of the token.", - "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 a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "deletePreReceiveEnvironment", - "method": "DELETE", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Cannot delete environment that has hooks_\n* _Cannot delete environment when download is in progress_", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#delete-a-pre-receive-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.", - "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": 422, - "description": "Client Errors", - "examples": [ - { - "data": "{\"message\":\"Validation Failed\",\"errors\":[{\"resource\":\"PreReceiveEnvironment\",\"code\":\"custom\",\"message\":\"Cannot modify or delete the default environment\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a pre-receive hook", - "scope": "enterpriseAdmin", - "id": "deletePreReceiveHook", - "method": "DELETE", - "url": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#delete-a-pre-receive-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "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 a public key", - "scope": "enterpriseAdmin", - "id": "deletePublicKey", - "method": "DELETE", - "url": "/admin/keys/{key_ids}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#delete-a-public-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_ids", - "description": "The unique identifier of the key.", - "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": "Delete a user", - "scope": "enterpriseAdmin", - "id": "deleteUser", - "method": "DELETE", - "url": "/admin/users/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#delete-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Demote a site administrator", - "scope": "enterpriseAdmin", - "id": "demoteSiteAdministrator", - "method": "DELETE", - "url": "/users/{username}/site_admin", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can demote any user account except your own.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#demote-a-site-administrator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Disable a selected organization for GitHub Actions in an enterprise", - "scope": "enterpriseAdmin", - "id": "disableSelectedOrganizationGithubActionsEnterprise", - "method": "DELETE", - "url": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#disable-a-selected-organization-for-github-actions-in-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "org_id", - "description": "The unique identifier of the organization.", - "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": "Enable or disable maintenance mode", - "scope": "enterpriseAdmin", - "id": "enableOrDisableMaintenanceMode", - "method": "POST", - "url": "{origin}/setup/api/maintenance", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#enable-or-disable-maintenance-mode", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "maintenance", - "description": "A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"status\":\"scheduled\",\"scheduled_time\":\"Tuesday, January 22 at 15:34 -0800\",\"connection_services\":[{\"name\":\"git operations\",\"number\":0},{\"name\":\"mysql queries\",\"number\":233},{\"name\":\"aqueduct jobs\",\"number\":34},{\"name\":\"resque jobs\",\"number\":54}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Enable a selected organization for GitHub Actions in an enterprise", - "scope": "enterpriseAdmin", - "id": "enableSelectedOrganizationGithubActionsEnterprise", - "method": "PUT", - "url": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#enable-a-selected-organization-for-github-actions-in-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "org_id", - "description": "The unique identifier of the organization.", - "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": "Get all authorized SSH keys", - "scope": "enterpriseAdmin", - "id": "getAllAuthorizedSshKeys", - "method": "GET", - "url": "{origin}/setup/api/settings/authorized-keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-all-authorized-ssh-keys", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get all statistics", - "scope": "enterpriseAdmin", - "id": "getAllStats", - "method": "GET", - "url": "/enterprise/stats/all", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"repos\":{\"total_repos\":212,\"root_repos\":194,\"fork_repos\":18,\"org_repos\":51,\"total_pushes\":3082,\"total_wikis\":15},\"hooks\":{\"total_hooks\":27,\"active_hooks\":23,\"inactive_hooks\":4},\"pages\":{\"total_pages\":36},\"orgs\":{\"total_orgs\":33,\"disabled_orgs\":0,\"total_teams\":60,\"total_team_members\":314},\"users\":{\"total_users\":254,\"admin_users\":45,\"suspended_users\":21},\"pulls\":{\"total_pulls\":86,\"merged_pulls\":60,\"mergeable_pulls\":21,\"unmergeable_pulls\":3},\"issues\":{\"total_issues\":179,\"open_issues\":83,\"closed_issues\":96},\"milestones\":{\"total_milestones\":7,\"open_milestones\":6,\"closed_milestones\":1},\"gists\":{\"total_gists\":178,\"private_gists\":151,\"public_gists\":25},\"comments\":{\"total_commit_comments\":6,\"total_gist_comments\":28,\"total_issue_comments\":366,\"total_pull_request_comments\":30}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get allowed actions for an enterprise", - "scope": "enterpriseAdmin", - "id": "getAllowedActionsEnterprise", - "method": "GET", - "url": "/enterprises/{enterprise}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-allowed-actions-for-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the global announcement banner", - "scope": "enterpriseAdmin", - "id": "getAnnouncement", - "method": "GET", - "url": "/enterprise/announcement", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the current message and expiration date of the global announcement banner in your enterprise.", - "documentationUrl": "", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"announcement\":\"Very **important** announcement about _nothing_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get comment statistics", - "scope": "enterpriseAdmin", - "id": "getCommentStats", - "method": "GET", - "url": "/enterprise/stats/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-comment-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get the configuration status", - "scope": "enterpriseAdmin", - "id": "getConfigurationStatus", - "method": "GET", - "url": "{origin}/setup/api/configcheck", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status | Description |\n| ------------- | --------------------------------- |\n| `PENDING` | The job has not started yet |\n| `CONFIGURING` | The job is running |\n| `DONE` | The job has finished correctly |\n| `FAILED` | The job has finished unexpectedly |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-the-configuration-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"status\":\"running\",\"progress\":[{\"status\":\"DONE\",\"key\":\"Appliance core components\"},{\"status\":\"DONE\",\"key\":\"GitHub utilities\"},{\"status\":\"DONE\",\"key\":\"GitHub applications\"},{\"status\":\"CONFIGURING\",\"key\":\"GitHub services\"},{\"status\":\"PENDING\",\"key\":\"Reloading appliance services\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the download status for a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "getDownloadStatusForPreReceiveEnvironment", - "method": "GET", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - "isDeprecated": false, - "deprecationDate": null, - "description": "In addition to seeing the download status at the \"[Get a pre-receive environment](#get-a-pre-receive-environment)\" endpoint, there is also this separate endpoint for just the download status.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-the-download-status-for-a-pre-receive-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get gist statistics", - "scope": "enterpriseAdmin", - "id": "getGistStats", - "method": "GET", - "url": "/enterprise/stats/gists", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-gist-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get GitHub Actions permissions for an enterprise", - "scope": "enterpriseAdmin", - "id": "getGithubActionsPermissionsEnterprise", - "method": "GET", - "url": "/enterprises/{enterprise}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#get-github-actions-permissions-for-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"enabled_organizations\":\"all\",\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/enterprises/2/actions/permissions/selected-actions\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a global webhook", - "scope": "enterpriseAdmin", - "id": "getGlobalWebhook", - "method": "GET", - "url": "/admin/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-a-global-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\",\"user\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get hooks statistics", - "scope": "enterpriseAdmin", - "id": "getHooksStats", - "method": "GET", - "url": "/enterprise/stats/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-hooks-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get issue statistics", - "scope": "enterpriseAdmin", - "id": "getIssueStats", - "method": "GET", - "url": "/enterprise/stats/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-issues-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get license information", - "scope": "enterpriseAdmin", - "id": "getLicenseInformation", - "method": "GET", - "url": "/enterprise/settings/license", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-license-information", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"seats\":1400,\"seats_used\":1316,\"seats_available\":84,\"kind\":\"standard\",\"days_until_expiration\":365,\"expire_at\":\"2016/02/06 12:41:52 -0600\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the maintenance status", - "scope": "enterpriseAdmin", - "id": "getMaintenanceStatus", - "method": "GET", - "url": "{origin}/setup/api/maintenance", - "isDeprecated": false, - "deprecationDate": null, - "description": "Check your installation's maintenance status:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-the-maintenance-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"status\":\"scheduled\",\"scheduled_time\":\"Tuesday, January 22 at 15:34 -0800\",\"connection_services\":[{\"name\":\"git operations\",\"number\":0},{\"name\":\"mysql queries\",\"number\":233},{\"name\":\"aqueduct jobs\",\"number\":34},{\"name\":\"resque jobs\",\"number\":54}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get milestone statistics", - "scope": "enterpriseAdmin", - "id": "getMilestoneStats", - "method": "GET", - "url": "/enterprise/stats/milestones", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-milestone-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get organization statistics", - "scope": "enterpriseAdmin", - "id": "getOrgStats", - "method": "GET", - "url": "/enterprise/stats/orgs", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-organization-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get pages statistics", - "scope": "enterpriseAdmin", - "id": "getPagesStats", - "method": "GET", - "url": "/enterprise/stats/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-pages-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "getPreReceiveEnvironment", - "method": "GET", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-a-pre-receive-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.", - "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\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":null,\"message\":null}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a pre-receive hook", - "scope": "enterpriseAdmin", - "id": "getPreReceiveHook", - "method": "GET", - "url": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-a-pre-receive-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "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\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a pre-receive hook for an organization", - "scope": "enterpriseAdmin", - "id": "getPreReceiveHookForOrg", - "method": "GET", - "url": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "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\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\"allow_downstream_configuration\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a pre-receive hook for a repository", - "scope": "enterpriseAdmin", - "id": "getPreReceiveHookForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "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\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get pull request statistics", - "scope": "enterpriseAdmin", - "id": "getPullRequestStats", - "method": "GET", - "url": "/enterprise/stats/pulls", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-pull-requests-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get repository statistics", - "scope": "enterpriseAdmin", - "id": "getRepoStats", - "method": "GET", - "url": "/enterprise/stats/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-repository-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get settings", - "scope": "enterpriseAdmin", - "id": "getSettings", - "method": "GET", - "url": "{origin}/setup/api/settings", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#set-settings).\n\n**Note:** You cannot retrieve the management console password with the Enterprise administration API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-settings", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"enterprise\":{\"private_mode\":false,\"public_pages\":false,\"subdomain_isolation\":true,\"signup_enabled\":false,\"github_hostname\":\"ghe.local\",\"identicons_host\":\"dotcom\",\"http_proxy\":null,\"auth_mode\":\"default\",\"expire_sessions\":false,\"admin_password\":null,\"configuration_id\":1401777404,\"configuration_run_count\":4,\"avatar\":{\"enabled\":false,\"uri\":\"\"},\"customer\":{\"name\":\"GitHub\",\"email\":\"stannis@themannis.biz\",\"uuid\":\"af6cac80-e4e1-012e-d822-1231380e52e9\",\"secret_key_data\":\"-----BEGIN PGP PRIVATE KEY BLOCK-----\\nVersion: GnuPG v1.4.10 (GNU/Linux)\\n\\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\\n-----END PGP PRIVATE KEY BLOCK-----\\n\",\"public_key_data\":\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v1.4.10 (GNU/Linux)\\n\\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\\n-----END PGP PUBLIC KEY BLOCK-----\\n\"},\"license\":{\"seats\":0,\"evaluation\":false,\"perpetual\":false,\"unlimited_seating\":true,\"support_key\":\"ssh-rsa AAAAB3N....\",\"ssh_allowed\":true,\"cluster_support\":false,\"expire_at\":\"2016-04-27T00:00:00-07:00\"},\"github_ssl\":{\"enabled\":false,\"cert\":null,\"key\":null},\"ldap\":{\"host\":null,\"port\":0,\"base\":[],\"uid\":null,\"bind_dn\":null,\"password\":null,\"method\":\"Plain\",\"search_strategy\":\"detect\",\"user_groups\":[],\"admin_group\":null,\"virtual_attribute_enabled\":false,\"recursive_group_search\":false,\"posix_support\":true,\"user_sync_emails\":false,\"user_sync_keys\":false,\"user_sync_interval\":4,\"team_sync_interval\":4,\"sync_enabled\":false,\"reconciliation\":{\"user\":null,\"org\":null},\"profile\":{\"uid\":\"uid\",\"name\":null,\"mail\":null,\"key\":null}},\"cas\":{\"url\":null},\"saml\":{\"sso_url\":null,\"certificate\":null,\"certificate_path\":null,\"issuer\":null,\"idp_initiated_sso\":false,\"disable_admin_demote\":false},\"github_oauth\":{\"client_id\":\"12313412\",\"client_secret\":\"kj123131132\",\"organization_name\":\"Homestar Runners\",\"organization_team\":\"homestarrunners/characters\"},\"smtp\":{\"enabled\":true,\"address\":\"smtp.example.com\",\"authentication\":\"plain\",\"port\":\"1234\",\"domain\":\"blah\",\"username\":\"foo\",\"user_name\":\"mr_foo\",\"enable_starttls_auto\":true,\"password\":\"bar\",\"discard-to-noreply-address\":true,\"support_address\":\"enterprise@github.com\",\"support_address_type\":\"email\",\"noreply_address\":\"noreply@github.com\"},\"ntp\":{\"primary_server\":\"0.pool.ntp.org\",\"secondary_server\":\"1.pool.ntp.org\"},\"timezone\":null,\"snmp\":{\"enabled\":false,\"community\":\"\"},\"syslog\":{\"enabled\":false,\"server\":null,\"protocol_name\":\"udp\"},\"assets\":null,\"pages\":{\"enabled\":true},\"collectd\":{\"enabled\":false,\"server\":null,\"port\":0,\"encryption\":null,\"username\":null,\"password\":null},\"mapping\":{\"enabled\":true,\"tileserver\":null,\"basemap\":\"company.map-qsz2zrvs\",\"token\":null},\"load_balancer\":null},\"run_list\":[\"recipe[enterprise-configure]\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get users statistics", - "scope": "enterpriseAdmin", - "id": "getUserStats", - "method": "GET", - "url": "/enterprise/stats/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-users-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "List global webhooks", - "scope": "enterpriseAdmin", - "id": "listGlobalWebhooks", - "method": "GET", - "url": "/admin/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#list-global-webhooks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\",\"user\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List personal access tokens", - "scope": "enterpriseAdmin", - "id": "listPersonalAccessTokens", - "method": "GET", - "url": "/admin/tokens", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists personal access tokens for all users, including admin users.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#list-personal-access-tokens", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":2,\"url\":\"https://enterprise.octocat.com/api/v3/authorizations/2\",\"app\":{\"name\":\"My personal access token\",\"url\":\"https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens\",\"client_id\":\"00000000000000000000\"},\"token\":\"ghp_16C7e42F292c6912E7710c838347Ae178B4a\",\"hashed_token\":\"23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45\",\"token_last_eight\":\"Ae178B4a\",\"note\":\"My personal access token\",\"note_url\":null,\"created_at\":\"2019-04-24T21:49:02Z\",\"updated_at\":\"2019-04-24T21:49:02Z\",\"scopes\":[\"admin:business\",\"admin:gpg_key\",\"admin:org\",\"admin:org_hook\",\"admin:pre_receive_hook\",\"admin:public_key\",\"admin:repo_hook\",\"delete_repo\",\"gist\",\"notifications\",\"repo\",\"user\",\"write:discussion\"],\"fingerprint\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pre-receive environments", - "scope": "enterpriseAdmin", - "id": "listPreReceiveEnvironments", - "method": "GET", - "url": "/admin/pre-receive-environments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#list-pre-receive-environments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"name\":\"Default\",\"image_url\":\"githubenterprise://internal\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/1\",\"default_environment\":true,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":14,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pre-receive hooks", - "scope": "enterpriseAdmin", - "id": "listPreReceiveHooks", - "method": "GET", - "url": "/admin/pre-receive-hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#list-pre-receive-hooks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pre-receive hooks for an organization", - "scope": "enterpriseAdmin", - "id": "listPreReceiveHooksForOrg", - "method": "GET", - "url": "/orgs/{org}/pre-receive-hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The sort order for the response collection.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\"allow_downstream_configuration\":true}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pre-receive hooks for a repository", - "scope": "enterpriseAdmin", - "id": "listPreReceiveHooksForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/pre-receive-hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public keys", - "scope": "enterpriseAdmin", - "id": "listPublicKeys", - "method": "GET", - "url": "/admin/keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#list-public-keys", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "accessed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show public keys accessed after the given time.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false,\"last_used\":\"2020-06-11T22:31:57Z\",\"user_id\":1,\"repository_id\":2},{\"key\":\"9Og8iYjAyymI9LvABpJerYrMxURPc8r+dB7TJyvv1234\",\"id\":3,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false,\"last_used\":\"2020-06-11T22:31:57Z\",\"user_id\":1,\"repository_id\":2}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List selected organizations enabled for GitHub Actions in an enterprise", - "scope": "enterpriseAdmin", - "id": "listSelectedOrganizationsEnabledGithubActionsEnterprise", - "method": "GET", - "url": "/enterprises/{enterprise}/actions/permissions/organizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"organizations\":[{\"login\":\"octocat\",\"id\":161335,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"url\":\"https://api.github.com/orgs/octo-org\",\"repos_url\":\"https://api.github.com/orgs/octo-org/repos\",\"events_url\":\"https://api.github.com/orgs/octo-org/events\",\"hooks_url\":\"https://api.github.com/orgs/octo-org/hooks\",\"issues_url\":\"https://api.github.com/orgs/octo-org/issues\",\"members_url\":\"https://api.github.com/orgs/octo-org/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/octo-org/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Ping a global webhook", - "scope": "enterpriseAdmin", - "id": "pingGlobalWebhook", - "method": "POST", - "url": "/admin/hooks/{hook_id}/pings", - "isDeprecated": false, - "deprecationDate": null, - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.2/webhooks/#ping-event) to be sent to the webhook.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#ping-a-global-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Promote a user to be a site administrator", - "scope": "enterpriseAdmin", - "id": "promoteUserToBeSiteAdministrator", - "method": "PUT", - "url": "/users/{username}/site_admin", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#promote-a-user-to-be-a-site-administrator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove the global announcement banner", - "scope": "enterpriseAdmin", - "id": "removeAnnouncement", - "method": "DELETE", - "url": "/enterprise/announcement", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes the global announcement banner in your enterprise.", - "documentationUrl": "", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove an authorized SSH key", - "scope": "enterpriseAdmin", - "id": "removeAuthorizedSshKey", - "method": "DELETE", - "url": "{origin}/setup/api/settings/authorized-keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#remove-an-authorized-ssh-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "authorized_key", - "description": "The public SSH key.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove pre-receive hook enforcement for an organization", - "scope": "enterpriseAdmin", - "id": "removePreReceiveHookEnforcementForOrg", - "method": "DELETE", - "url": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes any overrides for this hook at the org level for this org.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "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\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\"allow_downstream_configuration\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove pre-receive hook enforcement for a repository", - "scope": "enterpriseAdmin", - "id": "removePreReceiveHookEnforcementForRepo", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes any overridden enforcement on this repository for the specified hook.\n\nResponds with effective values inherited from owner and/or global level.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Responds with effective values inherited from owner and/or global level.", - "examples": [ - { - "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set allowed actions for an enterprise", - "scope": "enterpriseAdmin", - "id": "setAllowedActionsEnterprise", - "method": "PUT", - "url": "/enterprises/{enterprise}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-allowed-actions-for-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "github_owned_allowed", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "patterns_allowed", - "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "in": "BODY", - "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": "Set the global announcement banner", - "scope": "enterpriseAdmin", - "id": "setAnnouncement", - "method": "PATCH", - "url": "/enterprise/announcement", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the message and expiration time for the global announcement banner in your enterprise.", - "documentationUrl": "", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "announcement", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.2/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "expires_at", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"announcement\":\"Very **important** announcement about _nothing_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set GitHub Actions permissions for an enterprise", - "scope": "enterpriseAdmin", - "id": "setGithubActionsPermissionsEnterprise", - "method": "PUT", - "url": "/enterprises/{enterprise}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-github-actions-permissions-for-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enabled_organizations", - "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["all", "none", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allowed_actions", - "description": "The permissions policy that controls the actions that are allowed to run.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "local_only", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Set selected organizations enabled for GitHub Actions in an enterprise", - "scope": "enterpriseAdmin", - "id": "setSelectedOrganizationsEnabledGithubActionsEnterprise", - "method": "PUT", - "url": "/enterprises/{enterprise}/actions/permissions/organizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/actions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_organization_ids", - "description": "List of organization IDs to enable for GitHub Actions.", - "in": "BODY", - "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 settings", - "scope": "enterpriseAdmin", - "id": "setSettings", - "method": "PUT", - "url": "{origin}/setup/api/settings", - "isDeprecated": false, - "deprecationDate": null, - "description": "Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-settings).\n\n**Notes:**\n\n- The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).\n- You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.2/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#set-settings", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "settings", - "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-settings).", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Start a configuration process", - "scope": "enterpriseAdmin", - "id": "startConfigurationProcess", - "method": "POST", - "url": "{origin}/setup/api/configure", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#start-a-configuration-process", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 202, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Start a pre-receive environment download", - "scope": "enterpriseAdmin", - "id": "startPreReceiveEnvironmentDownload", - "method": "POST", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - "isDeprecated": false, - "deprecationDate": null, - "description": "Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment.\n\nIf a download cannot be triggered, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Can not start a new download when a download is in progress_", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#start-a-pre-receive-environment-download", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":null,\"message\":null}" - } - ] - }, - { - "code": 422, - "description": "Client Errors", - "examples": [ - { - "data": "{\"message\":\"Validation Failed\",\"errors\":[{\"resource\":\"PreReceiveEnvironment\",\"code\":\"custom\",\"message\":\"Can not start a new download when a download is in progress\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Suspend a user", - "scope": "enterpriseAdmin", - "id": "suspendUser", - "method": "PUT", - "url": "/users/{username}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.2/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#suspend-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reason", - "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.2/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Sync LDAP mapping for a team", - "scope": "enterpriseAdmin", - "id": "syncLdapMappingForTeam", - "method": "POST", - "url": "/admin/ldap/teams/{team_id}/sync", - "isDeprecated": false, - "deprecationDate": null, - "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#sync-ldap-mapping-for-a-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [{ "data": "{\"status\":\"queued\"}" }] - } - ], - "renamed": null - }, - { - "name": "Sync LDAP mapping for a user", - "scope": "enterpriseAdmin", - "id": "syncLdapMappingForUser", - "method": "POST", - "url": "/admin/ldap/users/{username}/sync", - "isDeprecated": false, - "deprecationDate": null, - "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#sync-ldap-mapping-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [{ "data": "{\"status\":\"queued\"}" }] - } - ], - "renamed": null - }, - { - "name": "Unsuspend a user", - "scope": "enterpriseAdmin", - "id": "unsuspendUser", - "method": "DELETE", - "url": "/users/{username}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.2/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#unsuspend-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reason", - "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.2/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Update a global webhook", - "scope": "enterpriseAdmin", - "id": "updateGlobalWebhook", - "method": "PATCH", - "url": "/admin/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-a-global-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers) header.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "events", - "description": "The [events](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"form\",\"insecure_ssl\":\"0\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update LDAP mapping for a team", - "scope": "enterpriseAdmin", - "id": "updateLdapMappingForTeam", - "method": "PATCH", - "url": "/admin/ldap/teams/{team_id}/mapping", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.2/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.\n\nIf you pass the `hellcat-preview` media type, you can also update the LDAP mapping of a child team.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ldap_dn", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ldap_dn\":\"cn=Enterprise Ops,ou=teams,dc=github,dc=com\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update LDAP mapping for a user", - "scope": "enterpriseAdmin", - "id": "updateLdapMappingForUser", - "method": "PATCH", - "url": "/admin/ldap/users/{username}/mapping", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ldap_dn", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\",\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"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\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"twitter_username\":\"monatheoctocat\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"private_gists\":81,\"total_private_repos\":100,\"owned_private_repos\":100,\"disk_usage\":10000,\"collaborators\":8,\"two_factor_authentication\":true,\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"collaborators\":0}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update an organization name", - "scope": "enterpriseAdmin", - "id": "updateOrgName", - "method": "PATCH", - "url": "/admin/organizations/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-an-organization-name", - "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": "login", - "description": "The organization's new name.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"message\":\"Job queued to rename organization. It may take a few minutes to complete.\",\"url\":\"https:///api/v3/organizations/1\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "updatePreReceiveEnvironment", - "method": "PATCH", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-a-pre-receive-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "This pre-receive environment's new name.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "image_url", - "description": "URL from which to download a tarball of this environment.", - "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\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}}" - } - ] - }, - { - "code": 422, - "description": "Client Errors", - "examples": [ - { - "data": "{\"message\":\"Validation Failed\",\"errors\":[{\"resource\":\"PreReceiveEnvironment\",\"code\":\"custom\",\"message\":\"Cannot modify or delete the default environment\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a pre-receive hook", - "scope": "enterpriseAdmin", - "id": "updatePreReceiveHook", - "method": "PATCH", - "url": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-a-pre-receive-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "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 hook.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script", - "description": "The script that the hook runs.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script_repository", - "description": "The GitHub repository where the script is kept.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script_repository.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "The pre-receive environment where the script is executed.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforcement", - "description": "The state of enforcement for this hook.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_downstream_configuration", - "description": "Whether enforcement can be overridden at the org or repo level.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":1,\"name\":\"Default\",\"image_url\":\"githubenterprise://internal\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/1\",\"default_environment\":true,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update pre-receive hook enforcement for an organization", - "scope": "enterpriseAdmin", - "id": "updatePreReceiveHookEnforcementForOrg", - "method": "PATCH", - "url": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforcement", - "description": "The state of enforcement for the hook on this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_downstream_configuration", - "description": "Whether repositories can override enforcement.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"enabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\",\"allow_downstream_configuration\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update pre-receive hook enforcement for a repository", - "scope": "enterpriseAdmin", - "id": "updatePreReceiveHookEnforcementForRepo", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforcement", - "description": "The state of enforcement for the hook on this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["enabled", "disabled", "testing"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"enabled\",\"configuration_url\":\"https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update the username for a user", - "scope": "enterpriseAdmin", - "id": "updateUsernameForUser", - "method": "PATCH", - "url": "/admin/users/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-the-username-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "login", - "description": "The user's new username.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"message\":\"Job queued to rename user. It may take a few minutes to complete.\",\"url\":\"https://api.github.com/user/1\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Upgrade a license", - "scope": "enterpriseAdmin", - "id": "upgradeLicense", - "method": "POST", - "url": "{origin}/setup/api/upgrade", - "isDeprecated": false, - "deprecationDate": null, - "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#upgrade-a-license", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "license", - "description": "The content of your new _.ghl_ license file.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 202, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Check if a gist is starred", - "scope": "gists", - "id": "checkIsStarred", - "method": "GET", - "url": "/gists/{gist_id}/star", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#check-if-a-gist-is-starred", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if gist is starred", - "examples": null - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if gist is not starred", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a gist", - "scope": "gists", - "id": "create", - "method": "POST", - "url": "/gists", - "isDeprecated": false, - "deprecationDate": null, - "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#create-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "description", - "description": "Description of the gist", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files", - "description": "Names and content for the files that make up the gist", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*.content", - "description": "Content of the file", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "public", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a gist comment", - "scope": "gists", - "id": "createComment", - "method": "POST", - "url": "/gists/{gist_id}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#create-a-gist-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The comment text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"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},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a gist", - "scope": "gists", - "id": "delete", - "method": "DELETE", - "url": "/gists/{gist_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#delete-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "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 }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a gist comment", - "scope": "gists", - "id": "deleteComment", - "method": "DELETE", - "url": "/gists/{gist_id}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#delete-a-gist-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Fork a gist", - "scope": "gists", - "id": "fork", - "method": "POST", - "url": "/gists/{gist_id}/forks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#fork-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a gist", - "scope": "gists", - "id": "get", - "method": "GET", - "url": "/gists/{gist_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#get-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden Gist", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a gist comment", - "scope": "gists", - "id": "getComment", - "method": "GET", - "url": "/gists/{gist_id}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#get-a-gist-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"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},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden Gist", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a gist revision", - "scope": "gists", - "id": "getRevision", - "method": "GET", - "url": "/gists/{gist_id}/{sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#get-a-gist-revision", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" - } - ] - }, - { "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": "List gists for the authenticated user", - "scope": "gists", - "id": "list", - "method": "GET", - "url": "/gists", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#list-gists-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List gist comments", - "scope": "gists", - "id": "listComments", - "method": "GET", - "url": "/gists/{gist_id}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#list-gist-comments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"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},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List gist commits", - "scope": "gists", - "id": "listCommits", - "method": "GET", - "url": "/gists/{gist_id}/commits", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#list-gist-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"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},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List gists for a user", - "scope": "gists", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/gists", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists public gists for the specified user:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#list-gists-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List gist forks", - "scope": "gists", - "id": "listForks", - "method": "GET", - "url": "/gists/{gist_id}/forks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#list-gist-forks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":1,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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}}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List public gists", - "scope": "gists", - "id": "listPublic", - "method": "GET", - "url": "/gists/public", - "isDeprecated": false, - "deprecationDate": null, - "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@3.2/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#list-public-gists", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List starred gists", - "scope": "gists", - "id": "listStarred", - "method": "GET", - "url": "/gists/starred", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the authenticated user's starred gists:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#list-starred-gists", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Star a gist", - "scope": "gists", - "id": "star", - "method": "PUT", - "url": "/gists/{gist_id}/star", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#star-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "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 }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unstar a gist", - "scope": "gists", - "id": "unstar", - "method": "DELETE", - "url": "/gists/{gist_id}/star", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#unstar-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "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 }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a gist", - "scope": "gists", - "id": "update", - "method": "PATCH", - "url": "/gists/{gist_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists/#update-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "Description of the gist", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files", - "description": "Names of files to be updated", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*.content", - "description": "The new content of the file", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*.filename", - "description": "The new filename for the file", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a gist comment", - "scope": "gists", - "id": "updateComment", - "method": "PATCH", - "url": "/gists/{gist_id}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gists#update-a-gist-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The comment text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"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},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a blob", - "scope": "git", - "id": "createBlob", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/blobs", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#create-a-blob", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The new blob's content.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "encoding", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a commit", - "scope": "git", - "id": "createCommit", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/commits", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#create-a-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The commit message", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree", - "description": "The SHA of the tree object this commit points to", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parents", - "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author", - "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.email", - "description": "The email of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.date", - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer", - "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.email", - "description": "The email of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.date", - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "signature", - "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132\",\"sha\":\"827efc6d56897b048c772eb4087f854f46256132\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0\",\"sha\":\"7d1b31e74ee336d15cbd21741bc88a537ed063a0\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null},\"html_url\":\"https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd\"}" - } - ] - }, - { "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 a reference", - "scope": "git", - "id": "createRef", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/refs", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#create-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "The SHA1 value for this reference.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a tag object", - "scope": "git", - "id": "createTag", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/tags", - "isDeprecated": false, - "deprecationDate": null, - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.2/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.2/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#create-a-tag-object", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag", - "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The tag message.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "object", - "description": "The SHA of the git object this is tagging.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "type", - "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["commit", "tree", "blob"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger", - "description": "An object with information about the individual creating the tag.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger.name", - "description": "The name of the author of the tag", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger.email", - "description": "The email of the author of the tag", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger.date", - "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"node_id\":\"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\"tag\":\"v0.0.1\",\"sha\":\"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"message\":\"initial version\",\"tagger\":{\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\",\"date\":\"2014-11-07T22:01:45Z\"},\"object\":{\"type\":\"commit\",\"sha\":\"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a tree", - "scope": "git", - "id": "createTree", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/trees", - "isDeprecated": false, - "deprecationDate": null, - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@3.2/rest/reference/git#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-server@3.2/rest/reference/git#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#create-a-tree", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree", - "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", - "in": "BODY", - "type": "object[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].path", - "description": "The file referenced in the tree.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].mode", - "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["100644", "100755", "040000", "160000", "120000"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].type", - "description": "Either `blob`, `tree`, or `commit`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["blob", "tree", "commit"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].sha", - "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].content", - "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base_tree", - "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"sha\":\"cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\"tree\":[{\"path\":\"file.rb\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":132,\"sha\":\"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"}],\"truncated\":true}" - } - ] - }, - { "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": "Delete a reference", - "scope": "git", - "id": "deleteRef", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/git/refs/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#delete-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a blob", - "scope": "git", - "id": "getBlob", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#get-a-blob", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "file_sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content\":\"Q29udGVudCBvZiB0aGUgYmxvYg==\",\"encoding\":\"base64\",\"url\":\"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"size\":19,\"node_id\":\"Q29udGVudCBvZiB0aGUgYmxvYg==\"}" - } - ] - }, - { "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": "Get a commit", - "scope": "git", - "id": "getCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#get-a-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit.", - "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": "{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"added readme, because im a good github citizen\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a reference", - "scope": "git", - "id": "getRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/ref/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.2/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#get-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a tag", - "scope": "git", - "id": "getTag", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#get-a-tag", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag_sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"node_id\":\"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\"tag\":\"v0.0.1\",\"sha\":\"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"message\":\"initial version\",\"tagger\":{\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\",\"date\":\"2014-11-07T22:01:45Z\"},\"object\":{\"type\":\"commit\",\"sha\":\"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a tree", - "scope": "git", - "id": "getTree", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#get-a-tree", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree_sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "recursive", - "description": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `\"true\"`, and `\"false\"`. Omit this parameter to prevent recursively returning objects or subtrees.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"sha\":\"9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\"tree\":[{\"path\":\"file.rb\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":30,\"sha\":\"44b4fc6d56897b048c772eb4087f854f46256132\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132\"},{\"path\":\"subdir\",\"mode\":\"040000\",\"type\":\"tree\",\"sha\":\"f484d249c660418515fb01c2b9662073663c242e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e\"},{\"path\":\"exec_file\",\"mode\":\"100755\",\"type\":\"blob\",\"size\":75,\"sha\":\"45b983be36b73c0788dc9cbcb76cbb80fc7bb057\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057\"}],\"truncated\":false}" - }, - { - "data": "{\"sha\":\"fc6274d15fa3ae2ab983129fb037999f264ba9a7\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7\",\"tree\":[{\"path\":\"subdir/file.txt\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":132,\"sha\":\"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"}],\"truncated\":false}" - } - ] - }, - { "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 matching references", - "scope": "git", - "id": "listMatchingRefs", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.2/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#list-matching-references", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"ref\":\"refs/heads/feature-a\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}},{\"ref\":\"refs/heads/feature-b\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b\",\"object\":{\"type\":\"commit\",\"sha\":\"612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\"}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a reference", - "scope": "git", - "id": "updateRef", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/git/refs/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/git#update-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the fully qualified reference to update. For example, `refs/heads/master`. If the value doesn't start with `refs` and have at least two slashes, it will be rejected.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "The SHA1 value to set this reference to", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "force", - "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get all gitignore templates", - "scope": "gitignore", - "id": "getAllTemplates", - "method": "GET", - "url": "/gitignore/templates", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-repository-for-the-authenticated-user).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gitignore#get-all-gitignore-templates", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[\"Actionscript\",\"Android\",\"AppceleratorTitanium\",\"Autotools\",\"Bancha\",\"C\",\"C++\"]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a gitignore template", - "scope": "gitignore", - "id": "getTemplate", - "method": "GET", - "url": "/gitignore/templates/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "The API also allows fetching the source of a single template.\nUse the raw [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types/) to get the raw contents.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/gitignore#get-a-gitignore-template", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"C\",\"source\":\"# Object files\\n*.o\\n\\n# Libraries\\n*.lib\\n*.a\\n\\n# Shared objects (inc. Windows DLLs)\\n*.dll\\n*.so\\n*.so.*\\n*.dylib\\n\\n# Executables\\n*.exe\\n*.out\\n*.app\\n\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Add assignees to an issue", - "scope": "issues", - "id": "addAssignees", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "isDeprecated": false, - "deprecationDate": null, - "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#add-assignees-to-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add labels to an issue", - "scope": "issues", - "id": "addLabels", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#add-labels-to-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels[].name", - "description": "", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check if a user can be assigned", - "scope": "issues", - "id": "checkUserCanBeAssigned", - "method": "GET", - "url": "/repos/{owner}/{repo}/assignees/{assignee}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#check-if-a-user-can-be-assigned", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.", - "examples": null - }, - { - "code": 404, - "description": "Otherwise a `404` status code is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create an issue", - "scope": "issues", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#create-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the issue.", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the issue.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "in": "BODY", - "type": "undefined[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Create an issue comment", - "scope": "issues", - "id": "createComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#create-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a label", - "scope": "issues", - "id": "createLabel", - "method": "POST", - "url": "/repos/{owner}/{repo}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#create-a-label", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "color", - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the label. Must be 100 characters or fewer.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}" - } - ] - }, - { "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 a milestone", - "scope": "issues", - "id": "createMilestone", - "method": "POST", - "url": "/repos/{owner}/{repo}/milestones", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#create-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the milestone.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the milestone. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A description of the milestone.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "due_on", - "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete an issue comment", - "scope": "issues", - "id": "deleteComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#delete-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a label", - "scope": "issues", - "id": "deleteLabel", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#delete-a-label", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "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": "Delete a milestone", - "scope": "issues", - "id": "deleteMilestone", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#delete-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone_number", - "description": "The number that identifies the milestone.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an issue", - "scope": "issues", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#get-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an issue comment", - "scope": "issues", - "id": "getComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#get-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an issue event", - "scope": "issues", - "id": "getEvent", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/events/{event_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#get-an-issue-event", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"issue\":{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"performed_via_github_app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a label", - "scope": "issues", - "id": "getLabel", - "method": "GET", - "url": "/repos/{owner}/{repo}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#get-a-label", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a milestone", - "scope": "issues", - "id": "getMilestone", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#get-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone_number", - "description": "The number that identifies the milestone.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List issues assigned to the authenticated user", - "scope": "issues", - "id": "list", - "method": "GET", - "url": "/issues", - "isDeprecated": false, - "deprecationDate": 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 v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-issues-assigned-to-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "filter", - "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "collab", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "orgs", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owned", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pulls", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "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": "List assignees", - "scope": "issues", - "id": "listAssignees", - "method": "GET", - "url": "/repos/{owner}/{repo}/assignees", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-assignees", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List issue comments", - "scope": "issues", - "id": "listComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Issue Comments are ordered by ascending ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-issue-comments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List issue comments for a repository", - "scope": "issues", - "id": "listCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "By default, Issue Comments are ordered by ascending ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-issue-comments-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "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 issue events", - "scope": "issues", - "id": "listEvents", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-issue-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"performed_via_github_app\":null,\"label\":{\"name\":\"label\",\"color\":\"red\"}}]" - } - ] - }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List issue events for a repository", - "scope": "issues", - "id": "listEventsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-issue-events-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"issue\":{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List timeline events for an issue", - "scope": "issues", - "id": "listEventsForTimeline", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-timeline-events-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":6430295168,\"node_id\":\"LOE_lADODwFebM5HwC0kzwAAAAF_RoSA\",\"url\":\"https://api.github.com/repos/github/roadmap/issues/events/6430295168\",\"actor\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"event\":\"locked\",\"commit_id\":null,\"commit_url\":null,\"created_at\":\"2022-04-13T20:49:13Z\",\"lock_reason\":null,\"performed_via_github_app\":null},{\"id\":6430296748,\"node_id\":\"LE_lADODwFebM5HwC0kzwAAAAF_Roqs\",\"url\":\"https://api.github.com/repos/github/roadmap/issues/events/6430296748\",\"actor\":{\"login\":\"github-product-roadmap\",\"id\":67656570,\"node_id\":\"MDQ6VXNlcjY3NjU2NTcw\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/67656570?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github-product-roadmap\",\"html_url\":\"https://github.com/github-product-roadmap\",\"followers_url\":\"https://api.github.com/users/github-product-roadmap/followers\",\"following_url\":\"https://api.github.com/users/github-product-roadmap/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github-product-roadmap/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github-product-roadmap/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github-product-roadmap/orgs\",\"repos_url\":\"https://api.github.com/users/github-product-roadmap/repos\",\"events_url\":\"https://api.github.com/users/github-product-roadmap/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github-product-roadmap/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"labeled\",\"commit_id\":null,\"commit_url\":null,\"created_at\":\"2022-04-13T20:49:34Z\",\"label\":{\"name\":\"beta\",\"color\":\"99dd88\"},\"performed_via_github_app\":null},{\"id\":6635165802,\"node_id\":\"RTE_lADODwFebM5HwC0kzwAAAAGLfJhq\",\"url\":\"https://api.github.com/repos/github/roadmap/issues/events/6635165802\",\"actor\":{\"login\":\"github-product-roadmap\",\"id\":67656570,\"node_id\":\"MDQ6VXNlcjY3NjU2NTcw\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/67656570?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github-product-roadmap\",\"html_url\":\"https://github.com/github-product-roadmap\",\"followers_url\":\"https://api.github.com/users/github-product-roadmap/followers\",\"following_url\":\"https://api.github.com/users/github-product-roadmap/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github-product-roadmap/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github-product-roadmap/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github-product-roadmap/orgs\",\"repos_url\":\"https://api.github.com/users/github-product-roadmap/repos\",\"events_url\":\"https://api.github.com/users/github-product-roadmap/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github-product-roadmap/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"renamed\",\"commit_id\":null,\"commit_url\":null,\"created_at\":\"2022-05-18T19:29:01Z\",\"rename\":{\"from\":\"Secret scanning: dry-runs for enterprise-level custom patterns (cloud)\",\"to\":\"Secret scanning: dry-runs for enterprise-level custom patterns\"},\"performed_via_github_app\":null},{\"url\":\"https://api.github.com/repos/github/roadmap/issues/comments/1130876857\",\"html_url\":\"https://github.com/github/roadmap/issues/493#issuecomment-1130876857\",\"issue_url\":\"https://api.github.com/repos/github/roadmap/issues/493\",\"id\":1130876857,\"node_id\":\"IC_kwDODwFebM5DZ8-5\",\"user\":{\"login\":\"octocat\",\"id\":94867353,\"node_id\":\"U_kgDOBaePmQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/94867353?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"created_at\":\"2022-05-19T00:52:15Z\",\"updated_at\":\"2022-05-19T00:52:15Z\",\"author_association\":\"COLLABORATOR\",\"body\":\"🚢 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/\",\"reactions\":{\"url\":\"https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions\",\"total_count\":0,\"+1\":0,\"-1\":0,\"laugh\":0,\"hooray\":0,\"confused\":0,\"heart\":0,\"rocket\":0,\"eyes\":0},\"performed_via_github_app\":null,\"event\":\"commented\",\"actor\":{\"login\":\"octocat\",\"id\":94867353,\"node_id\":\"U_kgDOBaePmQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/94867353?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List user account issues assigned to the authenticated user", - "scope": "issues", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "filter", - "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List organization issues assigned to the authenticated user", - "scope": "issues", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-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": "filter", - "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository issues", - "scope": "issues", - "id": "listForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-repository-issues", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone", - "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "creator", - "description": "The user that created the issue.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "mentioned", - "description": "A user that's mentioned in the issue.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "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": "List labels for issues in a milestone", - "scope": "issues", - "id": "listLabelsForMilestone", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-labels-for-issues-in-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone_number", - "description": "The number that identifies the milestone.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List labels for a repository", - "scope": "issues", - "id": "listLabelsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-labels-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List labels for an issue", - "scope": "issues", - "id": "listLabelsOnIssue", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-labels-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List milestones", - "scope": "issues", - "id": "listMilestones", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#list-milestones", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the milestone. Either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by. Either `due_on` or `completeness`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["due_on", "completeness"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction of the sort. Either `asc` or `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Lock an issue", - "scope": "issues", - "id": "lock", - "method": "PUT", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#lock-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "lock_reason", - "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["off-topic", "too heated", "resolved", "spam"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove all labels from an issue", - "scope": "issues", - "id": "removeAllLabels", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#remove-all-labels-from-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove assignees from an issue", - "scope": "issues", - "id": "removeAssignees", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes one or more assignees from an issue.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove a label from an issue", - "scope": "issues", - "id": "removeLabel", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#remove-a-label-from-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Set labels for an issue", - "scope": "issues", - "id": "setLabels", - "method": "PUT", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes any previous labels and sets the new labels for an issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#set-labels-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels[].name", - "description": "", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Unlock an issue", - "scope": "issues", - "id": "unlock", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access can unlock an issue's conversation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#unlock-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an issue", - "scope": "issues", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/issues/{issue_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Issue owners and users with push access can edit an issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues/#update-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the issue.", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the issue.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "State of the issue. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state_reason", - "description": "The reason for the current state", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["completed", "not_planned", "reopened"], - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", - "in": "BODY", - "type": "undefined[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "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\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an issue comment", - "scope": "issues", - "id": "updateComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#update-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a label", - "scope": "issues", - "id": "updateLabel", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#update-a-label", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "new_name", - "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "color", - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the label. Must be 100 characters or fewer.", - "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\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:\",\"name\":\"bug :bug:\",\"description\":\"Small bug fix required\",\"color\":\"b01f26\",\"default\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a milestone", - "scope": "issues", - "id": "updateMilestone", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/issues#update-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone_number", - "description": "The number that identifies the milestone.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the milestone.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the milestone. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A description of the milestone.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "due_on", - "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a license", - "scope": "licenses", - "id": "get", - "method": "GET", - "url": "/licenses/{license}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/licenses#get-a-license", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "license", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"http://choosealicense.com/licenses/mit/\",\"description\":\"A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.\",\"implementation\":\"Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.\",\"permissions\":[\"commercial-use\",\"modifications\",\"distribution\",\"sublicense\",\"private-use\"],\"conditions\":[\"include-copyright\"],\"limitations\":[\"no-liability\"],\"body\":\"\\n\\nThe MIT License (MIT)\\n\\nCopyright (c) [year] [fullname]\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in all\\ncopies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\\nSOFTWARE.\\n\",\"featured\":true}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all commonly used licenses", - "scope": "licenses", - "id": "getAllCommonlyUsed", - "method": "GET", - "url": "/licenses", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/licenses#get-all-commonly-used-licenses", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "featured", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"lgpl-3.0\",\"name\":\"GNU Lesser General Public License v3.0\",\"spdx_id\":\"LGPL-3.0\",\"url\":\"https://api.github.com/licenses/lgpl-3.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"mpl-2.0\",\"name\":\"Mozilla Public License 2.0\",\"spdx_id\":\"MPL-2.0\",\"url\":\"https://api.github.com/licenses/mpl-2.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"agpl-3.0\",\"name\":\"GNU Affero General Public License v3.0\",\"spdx_id\":\"AGPL-3.0\",\"url\":\"https://api.github.com/licenses/agpl-3.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"unlicense\",\"name\":\"The Unlicense\",\"spdx_id\":\"Unlicense\",\"url\":\"https://api.github.com/licenses/unlicense\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"apache-2.0\",\"name\":\"Apache License 2.0\",\"spdx_id\":\"Apache-2.0\",\"url\":\"https://api.github.com/licenses/apache-2.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"gpl-3.0\",\"name\":\"GNU General Public License v3.0\",\"spdx_id\":\"GPL-3.0\",\"url\":\"https://api.github.com/licenses/gpl-3.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the license for a repository", - "scope": "licenses", - "id": "getForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/license", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/licenses/#get-the-license-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"LICENSE\",\"path\":\"LICENSE\",\"sha\":\"401c59dcc4570b954dd6d345e76199e1f4e76266\",\"size\":1077,\"url\":\"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\"html_url\":\"https://github.com/benbalter/gman/blob/master/LICENSE\",\"git_url\":\"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\"download_url\":\"https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true\",\"type\":\"file\",\"content\":\"VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\\n\",\"encoding\":\"base64\",\"_links\":{\"self\":\"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\"git\":\"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\"html\":\"https://github.com/benbalter/gman/blob/master/LICENSE\"},\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Render a Markdown document", - "scope": "markdown", - "id": "render", - "method": "POST", - "url": "/markdown", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/markdown#render-a-markdown-document", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "text", - "description": "The Markdown text to render in HTML.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "mode", - "description": "The rendering mode.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["markdown", "gfm"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "context", - "description": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Render a Markdown document in raw mode", - "scope": "markdown", - "id": "renderRaw", - "method": "POST", - "url": "/markdown/raw", - "isDeprecated": false, - "deprecationDate": null, - "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/markdown#render-a-markdown-document-in-raw-mode", - "previews": [], - "headers": [ - { "name": "content-type", "value": "text/plain; charset=utf-8" } - ], - "parameters": [ - { - "name": "data", - "description": "raw markdown text", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get GitHub Enterprise Server meta information", - "scope": "meta", - "id": "get", - "method": "GET", - "url": "/meta", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/meta#get-github-meta-information", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"verifiable_password_authentication\":true,\"packages\":[\"192.30.252.0/22\"],\"dependabot\":[\"54.158.161.132\"],\"installed_version\":\"3.2.0\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get Octocat", - "scope": "meta", - "id": "getOctocat", - "method": "GET", - "url": "/octocat", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get the octocat as ASCII art", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/meta#get-octocat", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "s", - "description": "The words to show in Octocat's speech bubble", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "\" MMM. .MMM\\n MMMMMMMMMMMMMMMMMMM\\n MMMMMMMMMMMMMMMMMMM ___________________________________\\n MMMMMMMMMMMMMMMMMMMMM | |\\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\\n MMMM::- -:::::::- -::MMMM |/\\n MM~:~ 00~:::::~ 00~:~MM\\n .. MMMMM::.00:::+:::.00::MMMMM ..\\n .MM::::: ._. :::::MM.\\n MMMM;:::::;MMMM\\n -MM MMMMMMM\\n ^ M+ MMMMMMMMM\\n MMMMMMM MM MM MM\\n MM MM MM MM\\n MM MM MM MM\\n .~~MM~MM~MM~MM~~.\\n ~~~~MM:~MM~~~MM~:MM~~~~\\n ~~~~~~==~==~~~==~==~~~~~~\\n ~~~~~~==~==~==~==~~~~~~\\n :~==~==~==~==~~\\n\"" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the Zen of GitHub", - "scope": "meta", - "id": "getZen", - "method": "GET", - "url": "/zen", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get a random sentence from the Zen of GitHub", - "documentationUrl": "", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "\"Responsive is better than fast\"" }] - } - ], - "renamed": null - }, - { - "name": "GitHub API Root", - "scope": "meta", - "id": "root", - "method": "GET", - "url": "/", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get Hypermedia links to resources accessible in GitHub's REST API", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#root-endpoint", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"current_user_url\":\"https://api.github.com/user\",\"current_user_authorizations_html_url\":\"https://github.com/settings/connections/applications{/client_id}\",\"authorizations_url\":\"https://api.github.com/authorizations\",\"code_search_url\":\"https://api.github.com/search/code?q={query}{&page,per_page,sort,order}\",\"commit_search_url\":\"https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}\",\"emails_url\":\"https://api.github.com/user/emails\",\"emojis_url\":\"https://api.github.com/emojis\",\"events_url\":\"https://api.github.com/events\",\"feeds_url\":\"https://api.github.com/feeds\",\"followers_url\":\"https://api.github.com/user/followers\",\"following_url\":\"https://api.github.com/user/following{/target}\",\"gists_url\":\"https://api.github.com/gists{/gist_id}\",\"hub_url\":\"https://api.github.com/hub\",\"issue_search_url\":\"https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}\",\"issues_url\":\"https://api.github.com/issues\",\"keys_url\":\"https://api.github.com/user/keys\",\"label_search_url\":\"https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}\",\"notifications_url\":\"https://api.github.com/notifications\",\"organization_url\":\"https://api.github.com/orgs/{org}\",\"organization_repositories_url\":\"https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}\",\"organization_teams_url\":\"https://api.github.com/orgs/{org}/teams\",\"public_gists_url\":\"https://api.github.com/gists/public\",\"rate_limit_url\":\"https://api.github.com/rate_limit\",\"repository_url\":\"https://api.github.com/repos/{owner}/{repo}\",\"repository_search_url\":\"https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}\",\"current_user_repositories_url\":\"https://api.github.com/user/repos{?type,page,per_page,sort}\",\"starred_url\":\"https://api.github.com/user/starred{/owner}{/repo}\",\"starred_gists_url\":\"https://api.github.com/gists/starred\",\"topic_search_url\":\"https://api.github.com/search/topics?q={query}{&page,per_page}\",\"user_url\":\"https://api.github.com/users/{user}\",\"user_organizations_url\":\"https://api.github.com/user/orgs\",\"user_repositories_url\":\"https://api.github.com/users/{user}/repos{?type,page,per_page,sort}\",\"user_search_url\":\"https://api.github.com/search/users?q={query}{&page,per_page,sort,order}\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Check organization membership for a user", - "scope": "orgs", - "id": "checkMembershipForUser", - "method": "GET", - "url": "/orgs/{org}/members/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Check if a user is, publicly or privately, a member of the organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#check-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 - } - ], - "responses": [ - { - "code": 204, - "description": "Response if requester is an organization member and user is a member", - "examples": null - }, - { - "code": 302, - "description": "Response if requester is not an organization member", - "examples": null - }, - { - "code": 404, - "description": "Not Found if requester is an organization member and user is not a member", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check public organization membership for a user", - "scope": "orgs", - "id": "checkPublicMembershipForUser", - "method": "GET", - "url": "/orgs/{org}/public_members/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#check-public-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 - } - ], - "responses": [ - { - "code": 204, - "description": "Response if user is a public member", - "examples": null - }, - { - "code": 404, - "description": "Not Found if user is not a public member", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Convert an organization member to outside collaborator", - "scope": "orgs", - "id": "convertMemberToOutsideCollaborator", - "method": "PUT", - "url": "/orgs/{org}/outside_collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.2/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator", - "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": "async", - "description": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "User is getting converted asynchronously", - "examples": [{ "data": "null" }] - }, - { "code": 204, "description": "User was converted", "examples": null }, - { - "code": 403, - "description": "Forbidden if user is the last owner of the organization or not a member of the organization.", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create an organization webhook", - "scope": "orgs", - "id": "createWebhook", - "method": "POST", - "url": "/orgs/{org}/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Here's how you can create a hook that posts payloads in JSON format:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#create-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Must be passed as \"web\".", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#create-hook-config-params).", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.username", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.password", - "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/enterprise-server@3.2/webhooks/event-payloads) the hook is triggered for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"deliveries_url\":\"https://api.github.com/orgs/octocat/hooks/1/deliveries\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete an organization webhook", - "scope": "orgs", - "id": "deleteWebhook", - "method": "DELETE", - "url": "/orgs/{org}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#delete-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an organization", - "scope": "orgs", - "id": "get", - "method": "GET", - "url": "/orgs/{org}", - "isDeprecated": false, - "deprecationDate": 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 Enterprise Server plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#get-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": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an organization membership for the authenticated user", - "scope": "orgs", - "id": "getMembershipForAuthenticatedUser", - "method": "GET", - "url": "/user/memberships/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-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 - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"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": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get organization membership for a user", - "scope": "orgs", - "id": "getMembershipForUser", - "method": "GET", - "url": "/orgs/{org}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#get-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 - } - ], - "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": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an organization webhook", - "scope": "orgs", - "id": "getWebhook", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#get-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"deliveries_url\":\"https://api.github.com/orgs/octocat/hooks/1/deliveries\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a webhook configuration for an organization", - "scope": "orgs", - "id": "getWebhookConfigForOrg", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}/config", - "isDeprecated": false, - "deprecationDate": 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/reference/orgs#get-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#get-a-webhook-configuration-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a webhook delivery for an organization webhook", - "scope": "orgs", - "id": "getWebhookDelivery", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a delivery for a webhook configured in an organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#get-a-webhook-delivery-for-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delivery_id", - "description": "", - "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\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"url\":\"https://www.example.com\",\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List organizations", - "scope": "orgs", - "id": "list", - "method": "GET", - "url": "/organizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#list-organizations", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "An organization ID. Only return organizations with an ID greater than this ID.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "List app installations for an organization", - "scope": "orgs", - "id": "listAppInstallations", - "method": "GET", - "url": "/orgs/{org}/installations", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#list-app-installations-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"installations\":[{\"id\":25381,\"account\":{\"login\":\"octo-org\",\"id\":6811672,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=\",\"avatar_url\":\"https://avatars3.githubusercontent.com/u/6811672?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"selected\",\"access_tokens_url\":\"https://api.github.com/app/installations/25381/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/octo-org/settings/installations/25381\",\"app_id\":2218,\"target_id\":6811672,\"target_type\":\"Organization\",\"permissions\":{\"deployments\":\"write\",\"metadata\":\"read\",\"pull_requests\":\"read\",\"statuses\":\"read\"},\"events\":[\"deployment\",\"deployment_status\"],\"created_at\":\"2017-05-16T08:47:09.000-07:00\",\"updated_at\":\"2017-06-06T11:23:23.000-07:00\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organizations for the authenticated user", - "scope": "orgs", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/orgs", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#list-organizations-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List organizations for a user", - "scope": "orgs", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/orgs", - "isDeprecated": false, - "deprecationDate": null, - "description": "List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#list-organizations-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organization members", - "scope": "orgs", - "id": "listMembers", - "method": "GET", - "url": "/orgs/{org}/members", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#list-organization-members", - "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": "filter", - "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["2fa_disabled", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "Filter members returned by their role.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "admin", "member"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List organization memberships for the authenticated user", - "scope": "orgs", - "id": "listMembershipsForAuthenticatedUser", - "method": "GET", - "url": "/user/memberships/orgs", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "state", - "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["active", "pending"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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}},{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"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": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "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", - "id": "listOutsideCollaborators", - "method": "GET", - "url": "/orgs/{org}/outside_collaborators", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all users who are outside collaborators of an organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#list-outside-collaborators-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["2fa_disabled", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public organization members", - "scope": "orgs", - "id": "listPublicMembers", - "method": "GET", - "url": "/orgs/{org}/public_members", - "isDeprecated": false, - "deprecationDate": null, - "description": "Members of an organization can choose to have their membership publicized or not.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#list-public-organization-members", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List deliveries for an organization webhook", - "scope": "orgs", - "id": "listWebhookDeliveries", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}/deliveries", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#list-deliveries-for-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "cursor", - "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456},{\"id\":123456789,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-04T00:57:16Z\",\"redelivery\":true,\"duration\":0.28,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456}]" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List organization webhooks", - "scope": "orgs", - "id": "listWebhooks", - "method": "GET", - "url": "/orgs/{org}/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#list-organization-webhooks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"deliveries_url\":\"https://api.github.com/orgs/octocat/hooks/1/deliveries\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Ping an organization webhook", - "scope": "orgs", - "id": "pingWebhook", - "method": "POST", - "url": "/orgs/{org}/hooks/{hook_id}/pings", - "isDeprecated": false, - "deprecationDate": null, - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.2/webhooks/#ping-event) to be sent to the hook.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#ping-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Redeliver a delivery for an organization webhook", - "scope": "orgs", - "id": "redeliverWebhookDelivery", - "method": "POST", - "url": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Redeliver a delivery for a webhook configured in an organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#redeliver-a-delivery-for-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delivery_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove an organization member", - "scope": "orgs", - "id": "removeMember", - "method": "DELETE", - "url": "/orgs/{org}/members/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#remove-an-organization-member", - "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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove organization membership for a user", - "scope": "orgs", - "id": "removeMembershipForUser", - "method": "DELETE", - "url": "/orgs/{org}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#remove-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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove outside collaborator from an organization", - "scope": "orgs", - "id": "removeOutsideCollaborator", - "method": "DELETE", - "url": "/orgs/{org}/outside_collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removing a user from this list will remove them from all the organization's repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#remove-outside-collaborator-from-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 422, - "description": "Unprocessable Entity if user is a member of the organization", - "examples": [ - { - "data": "{\"message\":\"You cannot specify an organization member to remove as an outside collaborator.\",\"documentation_url\":\"https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#remove-outside-collaborator\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove public organization membership for the authenticated user", - "scope": "orgs", - "id": "removePublicMembershipForAuthenticatedUser", - "method": "DELETE", - "url": "/orgs/{org}/public_members/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-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 - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Set organization membership for a user", - "scope": "orgs", - "id": "setMembershipForUser", - "method": "PUT", - "url": "/orgs/{org}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/orgs#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/enterprise-server@3.2/rest/reference/orgs#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, - "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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an organization", - "scope": "orgs", - "id": "update", - "method": "PATCH", - "url": "/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs/#update-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "billing_email", - "description": "Billing email address. This address is not publicized.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "company", - "description": "The company name.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "email", - "description": "The publicly visible email address.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "twitter_username", - "description": "The Twitter username of the company.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "location", - "description": "The location.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The shorthand name of the company.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the company.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_organization_projects", - "description": "Whether an organization can use organization projects.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_repository_projects", - "description": "Whether repositories that belong to the organization can use repository projects.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "default_repository_permission", - "description": "Default permission level members have for organization repositories.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin", "none"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_repositories", - "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_internal_repositories", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_private_repositories", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_public_repositories", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_allowed_repository_creation_type", - "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "private", "none"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_pages", - "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "blog", - "description": "", - "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": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { "code": 409, "description": "Conflict", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an organization membership for the authenticated user", - "scope": "orgs", - "id": "updateMembershipForAuthenticatedUser", - "method": "PATCH", - "url": "/user/memberships/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-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": "state", - "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["active"], - "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": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update an organization webhook", - "scope": "orgs", - "id": "updateWebhook", - "method": "PATCH", - "url": "/orgs/{org}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#update-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#update-hook-config-params).", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "events", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads) the hook is triggered for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "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\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"deliveries_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries\",\"name\":\"web\",\"events\":[\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a webhook configuration for an organization", - "scope": "orgs", - "id": "updateWebhookConfigForOrg", - "method": "PATCH", - "url": "/orgs/{org}/hooks/{hook_id}/config", - "isDeprecated": false, - "deprecationDate": 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/reference/orgs#update-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/orgs#update-a-webhook-configuration-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add project collaborator", - "scope": "projects", - "id": "addCollaborator", - "method": "PUT", - "url": "/projects/{project_id}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#add-project-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "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": "permission", - "description": "The permission to grant the collaborator.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a project card", - "scope": "projects", - "id": "createCard", - "method": "POST", - "url": "/projects/columns/{column_id}/cards", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#create-a-project-card", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "note", - "description": "The project card's note", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_id", - "description": "The unique identifier of the content associated with the card", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_type", - "description": "The piece of content associated with the card", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 503, "description": "Response", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a project column", - "scope": "projects", - "id": "createColumn", - "method": "POST", - "url": "/projects/{project_id}/columns", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#create-a-project-column", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Name of the project column", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a user project", - "scope": "projects", - "id": "createForAuthenticatedUser", - "method": "POST", - "url": "/user/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#create-a-user-project", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "Name of the project", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "Body of the project", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/users/octocat\",\"url\":\"https://api.github.com/projects/1002603\",\"html_url\":\"https://github.com/users/octocat/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002603/columns\",\"id\":1002603,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDM=\",\"name\":\"My Projects\",\"body\":\"A board to manage my personal projects.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create an organization project", - "scope": "projects", - "id": "createForOrg", - "method": "POST", - "url": "/orgs/{org}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#create-an-organization-project", - "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": "name", - "description": "The name of the project.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The description of the project.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a repository project", - "scope": "projects", - "id": "createForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#create-a-repository-project", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the project.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The description of the project.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a project", - "scope": "projects", - "id": "delete", - "method": "DELETE", - "url": "/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#delete-a-project", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Delete Success", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a project card", - "scope": "projects", - "id": "deleteCard", - "method": "DELETE", - "url": "/projects/columns/cards/{card_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#delete-a-project-card", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a project column", - "scope": "projects", - "id": "deleteColumn", - "method": "DELETE", - "url": "/projects/columns/{column_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#delete-a-project-column", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a project", - "scope": "projects", - "id": "get", - "method": "GET", - "url": "/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#get-a-project", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "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": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a project card", - "scope": "projects", - "id": "getCard", - "method": "GET", - "url": "/projects/columns/cards/{card_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#get-a-project-card", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a project column", - "scope": "projects", - "id": "getColumn", - "method": "GET", - "url": "/projects/columns/{column_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#get-a-project-column", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get project permission for a user", - "scope": "projects", - "id": "getPermissionForUser", - "method": "GET", - "url": "/projects/{project_id}/collaborators/{username}/permission", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#get-project-permission-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List project cards", - "scope": "projects", - "id": "listCards", - "method": "GET", - "url": "/projects/columns/{column_id}/cards", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#list-project-cards", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "archived", "not_archived"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List project collaborators", - "scope": "projects", - "id": "listCollaborators", - "method": "GET", - "url": "/projects/{project_id}/collaborators", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the collaborators for an organization project. For a project, 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. You must be an organization owner or a project `admin` to list collaborators.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#list-project-collaborators", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["outside", "direct", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List project columns", - "scope": "projects", - "id": "listColumns", - "method": "GET", - "url": "/projects/{project_id}/columns", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#list-project-columns", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List organization projects", - "scope": "projects", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#list-organization-projects", - "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": "state", - "description": "Indicates the state of the projects to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List repository projects", - "scope": "projects", - "id": "listForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#list-repository-projects", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}]" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List user projects", - "scope": "projects", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#list-user-projects", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/users/octocat\",\"url\":\"https://api.github.com/projects/1002603\",\"html_url\":\"https://github.com/users/octocat/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002603/columns\",\"id\":1002603,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDM=\",\"name\":\"My Projects\",\"body\":\"A board to manage my personal projects.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Move a project card", - "scope": "projects", - "id": "moveCard", - "method": "POST", - "url": "/projects/columns/cards/{card_id}/moves", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#move-a-project-card", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:top|bottom|after:\\d+)$", - "alias": null, - "deprecated": null - }, - { - "name": "column_id", - "description": "The unique identifier of the column the card should be moved to", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [{ "data": "null" }] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Response", "examples": null } - ], - "renamed": null - }, - { - "name": "Move a project column", - "scope": "projects", - "id": "moveColumn", - "method": "POST", - "url": "/projects/columns/{column_id}/moves", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#move-a-project-column", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:first|last|after:\\d+)$", - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [{ "data": "null" }] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove user as a collaborator", - "scope": "projects", - "id": "removeCollaborator", - "method": "DELETE", - "url": "/projects/{project_id}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#remove-project-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a project", - "scope": "projects", - "id": "update", - "method": "PATCH", - "url": "/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#update-a-project", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Name of the project", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "Body of the project", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "State of the project; either 'open' or 'closed'", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "organization_permission", - "description": "The baseline permission that all organization members have on this project", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin", "none"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Whether or not this project can be seen by everyone.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if the authenticated user does not have access to the project", - "examples": null - }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update an existing project card", - "scope": "projects", - "id": "updateCard", - "method": "PATCH", - "url": "/projects/columns/cards/{card_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#update-a-project-card", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "note", - "description": "The project card's note", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "archived", - "description": "Whether or not the card is archived", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update an existing project column", - "scope": "projects", - "id": "updateColumn", - "method": "PATCH", - "url": "/projects/columns/{column_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/projects#update-a-project-column", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Name of the project column", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Check if a pull request has been merged", - "scope": "pulls", - "id": "checkIfMerged", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#check-if-a-pull-request-has-been-merged", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if pull request has been merged", - "examples": null - }, - { - "code": 404, - "description": "Not Found if pull request has not been merged", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a pull request", - "scope": "pulls", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls", - "isDeprecated": false, - "deprecationDate": 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#create-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the new pull request. Required unless `issue` is specified.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the pull request.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "draft", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue", - "description": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a reply for a review comment", - "scope": "pulls", - "id": "createReplyForReviewComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "isDeprecated": false, - "deprecationDate": 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#create-a-reply-for-a-review-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The text of the review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":426899381,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a review for a pull request", - "scope": "pulls", - "id": "createReview", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/pulls#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 v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/reference/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#create-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_id", - "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.2/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments", - "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].path", - "description": "The relative path to the file that necessitates a review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "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.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].body", - "description": "Text of the review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].line", - "description": "", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].side", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].start_line", - "description": "", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].start_side", - "description": "", - "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\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change.\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a review comment for a pull request", - "scope": "pulls", - "id": "createReviewComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see the [`comfort-fade` preview notice](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#create-a-review-comment-for-a-pull-request-preview-notices).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#create-a-review-comment-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The text of the review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_id", - "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "The relative path to the file that necessitates a comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "side", - "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["LEFT", "RIGHT"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "line", - "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "start_line", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "start_side", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["LEFT", "RIGHT", "side"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "in_reply_to", - "description": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a pending review for a pull request", - "scope": "pulls", - "id": "deletePendingReview", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#delete-a-pending-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "The unique identifier of the review.", - "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\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change.\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a review comment for a pull request", - "scope": "pulls", - "id": "deleteReviewComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a review comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#delete-a-review-comment-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Dismiss a review for a pull request", - "scope": "pulls", - "id": "dismissReview", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#dismiss-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "The unique identifier of the review.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The message for the pull request review dismissal", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["DISMISS"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"state\":\"DISMISSED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a pull request", - "scope": "pulls", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server 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/enterprise-server@3.2/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 Enterprise Server 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/enterprise-server@3.2/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#get-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a review for a pull request", - "scope": "pulls", - "id": "getReview", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#get-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "The unique identifier of the review.", - "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\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a review comment for a pull request", - "scope": "pulls", - "id": "getReviewComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Provides details for a review comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#get-a-review-comment-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List pull requests", - "scope": "pulls", - "id": "list", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Either `open`, `closed`, or `all` to filter by state.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "Filter pulls by base branch name. Example: `gh-pages`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "popularity", "long-running"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List comments for a pull request review", - "scope": "pulls", - "id": "listCommentsForReview", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "List comments for a specific pull request review.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-comments-for-a-pull-request-review", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "The unique identifier of the review.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List commits on a pull request", - "scope": "pulls", - "id": "listCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/repos#list-commits) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-commits-on-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pull requests files", - "scope": "pulls", - "id": "listFiles", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests-files", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 500, "description": "Internal Error", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all requested reviewers for a pull request", - "scope": "pulls", - "id": "listRequestedReviewers", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.2/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#get-all-requested-reviewers-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "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": "{\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List review comments on a pull request", - "scope": "pulls", - "id": "listReviewComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-review-comments-on-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort results. Ignored without `sort` parameter.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List review comments in a repository", - "scope": "pulls", - "id": "listReviewCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-review-comments-in-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "created_at"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort results. Ignored without `sort` parameter.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reviews for a pull request", - "scope": "pulls", - "id": "listReviews", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "The list of reviews returns in chronological order.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-reviews-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The list of reviews returns in chronological order.", - "examples": [ - { - "data": "[{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Merge a pull request", - "scope": "pulls", - "id": "merge", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#merge-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_title", - "description": "Title for the automatic commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_message", - "description": "Extra detail to append to automatic commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "SHA that pull request head must match to allow merge.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_method", - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["merge", "squash", "rebase"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if merge was successful", - "examples": [ - { - "data": "{\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"merged\":true,\"message\":\"Pull Request successfully merged\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 405, - "description": "Method Not Allowed if merge cannot be performed", - "examples": [ - { "data": "{\"message\":\"Pull Request is not mergeable\"}" } - ] - }, - { - "code": 409, - "description": "Conflict if sha was provided and pull request head did not match", - "examples": [ - { - "data": "{\"message\":\"Head branch was modified. Review and try the merge again.\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove requested reviewers from a pull request", - "scope": "pulls", - "id": "removeRequestedReviewers", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reviewers", - "description": "An array of user `login`s that will be removed.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_reviewers", - "description": "An array of team `slug`s that will be removed.", - "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": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Request reviewers for a pull request", - "scope": "pulls", - "id": "requestReviewers", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#request-reviewers-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reviewers", - "description": "An array of user `login`s that will be requested.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_reviewers", - "description": "An array of team `slug`s that will be requested.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Unprocessable Entity if user is not a collaborator", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Submit a review for a pull request", - "scope": "pulls", - "id": "submitReview", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/pulls#create-a-review-for-a-pull-request).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#submit-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "The unique identifier of the review.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body text of the pull request review", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "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": "Update a pull request", - "scope": "pulls", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls/#update-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the pull request.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the pull request.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "State of this Pull Request. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a pull request branch", - "scope": "pulls", - "id": "updateBranch", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#update-a-pull-request-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "expected_head_sha", - "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"message\":\"Updating pull request branch.\",\"url\":\"https://github.com/repos/octocat/Hello-World/pulls/53\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a review for a pull request", - "scope": "pulls", - "id": "updateReview", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Update the review summary comment with new text.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#update-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "The unique identifier of the review.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body text of the pull request review.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change. And add more about this.\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a review comment for a pull request", - "scope": "pulls", - "id": "updateReviewComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables you to edit a review comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#update-a-review-comment-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The text of the reply to the review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get rate limit status for the authenticated user", - "scope": "rateLimit", - "id": "get", - "method": "GET", - "url": "/rate_limit", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\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/enterprise-server@3.2/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"resources\":{\"core\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873,\"used\":1},\"search\":{\"limit\":30,\"remaining\":18,\"reset\":1372697452,\"used\":12},\"graphql\":{\"limit\":5000,\"remaining\":4993,\"reset\":1372700389,\"used\":7},\"integration_manifest\":{\"limit\":5000,\"remaining\":4999,\"reset\":1551806725,\"used\":1},\"code_scanning_upload\":{\"limit\":500,\"remaining\":499,\"reset\":1551806725,\"used\":1}},\"rate\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873,\"used\":1}}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create reaction for a commit comment", - "scope": "reactions", - "id": "createForCommitComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#create-reaction-for-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the commit comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Reaction exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Reaction created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create reaction for an issue", - "scope": "reactions", - "id": "createForIssue", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.2/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#create-reaction-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the issue.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create reaction for an issue comment", - "scope": "reactions", - "id": "createForIssueComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.2/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#create-reaction-for-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the issue comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Reaction exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Reaction created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create reaction for a pull request review comment", - "scope": "reactions", - "id": "createForPullRequestReviewComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the pull request review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Reaction exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Reaction created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create reaction for a release", - "scope": "reactions", - "id": "createForRelease", - "method": "POST", - "url": "/repos/{owner}/{repo}/releases/{release_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [release](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#create-reaction-for-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the release.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["+1", "laugh", "heart", "hooray", "rocket", "eyes"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Reaction exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Reaction created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create reaction for a team discussion comment", - "scope": "reactions", - "id": "createForTeamDiscussionCommentInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#create-reaction-for-a-team-discussion-comment", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response when the reaction type has already been added to this team discussion comment", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create reaction for a team discussion comment (Legacy)", - "scope": "reactions", - "id": "createForTeamDiscussionCommentLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "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/enterprise-server@3.2/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create reaction for a team discussion", - "scope": "reactions", - "id": "createForTeamDiscussionInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#create-reaction-for-a-team-discussion", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the team discussion.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create reaction for a team discussion (Legacy)", - "scope": "reactions", - "id": "createForTeamDiscussionLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "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/enterprise-server@3.2/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#create-reaction-for-a-team-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types) to add to the team discussion.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a commit comment reaction", - "scope": "reactions", - "id": "deleteForCommitComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#delete-a-commit-comment-reaction", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an issue reaction", - "scope": "reactions", - "id": "deleteForIssue", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-server@3.2/rest/reference/issues/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#delete-an-issue-reaction", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an issue comment reaction", - "scope": "reactions", - "id": "deleteForIssueComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.2/rest/reference/issues#comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#delete-an-issue-comment-reaction", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a pull request comment reaction", - "scope": "reactions", - "id": "deleteForPullRequestComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#review-comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#delete-a-pull-request-comment-reaction", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a release reaction", - "scope": "reactions", - "id": "deleteForRelease", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#releases).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#delete-a-release-reaction", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete team discussion reaction", - "scope": "reactions", - "id": "deleteForTeamDiscussion", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#delete-team-discussion-reaction", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete team discussion comment reaction", - "scope": "reactions", - "id": "deleteForTeamDiscussionComment", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#delete-team-discussion-comment-reaction", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a reaction (Legacy)", - "scope": "reactions", - "id": "deleteLegacy", - "method": "DELETE", - "url": "/reactions/{reaction_id}", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#discussion-comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#delete-a-reaction-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for a commit comment", - "scope": "reactions", - "id": "listForCommitComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#list-reactions-for-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for an issue", - "scope": "reactions", - "id": "listForIssue", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to an [issue](https://docs.github.com/enterprise-server@3.2/rest/reference/issues).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#list-reactions-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for an issue comment", - "scope": "reactions", - "id": "listForIssueComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.2/rest/reference/issues#comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#list-reactions-for-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for a pull request review comment", - "scope": "reactions", - "id": "listForPullRequestReviewComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#review-comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for a release", - "scope": "reactions", - "id": "listForRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [release](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#releases).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#list-reactions-for-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a release.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["+1", "laugh", "heart", "hooray", "rocket", "eyes"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion comment", - "scope": "reactions", - "id": "listForTeamDiscussionCommentInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#list-reactions-for-a-team-discussion-comment", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion comment (Legacy)", - "scope": "reactions", - "id": "listForTeamDiscussionCommentLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "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/enterprise-server@3.2/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion", - "scope": "reactions", - "id": "listForTeamDiscussionInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#list-reactions-for-a-team-discussion", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion (Legacy)", - "scope": "reactions", - "id": "listForTeamDiscussionLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "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/enterprise-server@3.2/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#list-reactions-for-a-team-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.2/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Accept a repository invitation", - "scope": "repos", - "id": "acceptInvitation", - "method": "PATCH", - "url": "/user/repository_invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/invitations#accept-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null } - ], - "renamed": { - "before": { "scope": "repos", "id": "acceptInvitation" }, - "after": { - "scope": "repos", - "id": "acceptInvitationForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Accept a repository invitation", - "scope": "repos", - "id": "acceptInvitationForAuthenticatedUser", - "method": "PATCH", - "url": "/user/repository_invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/invitations#accept-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null } - ], - "renamed": null - }, - { - "name": "Add app access restrictions", - "scope": "repos", - "id": "addAppAccessRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#add-app-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "apps", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add a repository collaborator", - "scope": "repos", - "id": "addCollaborator", - "method": "PUT", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/collaborators#add-a-repository-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "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": "permission", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response when a new invitation is created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}" - } - ] - }, - { - "code": 204, - "description": "Response when:\n- an existing collaborator is added as a collaborator\n- an organization member is added as an individual collaborator\n- an existing team member (whose team is also a repository collaborator) is added as an individual collaborator", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add status check contexts", - "scope": "repos", - "id": "addStatusCheckContexts", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#add-status-check-contexts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[\"continuous-integration/travis-ci\",\"continuous-integration/jenkins\"]" - } - ] - }, - { "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": "Add team access restrictions", - "scope": "repos", - "id": "addTeamAccessRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "deprecationDate": 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 teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#add-team-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "teams", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add user access restrictions", - "scope": "repos", - "id": "addUserAccessRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "isDeprecated": false, - "deprecationDate": 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 people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#add-user-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "users", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check if a user is a repository collaborator", - "scope": "repos", - "id": "checkCollaborator", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if user is a collaborator", - "examples": null - }, - { - "code": 404, - "description": "Not Found if user is not a collaborator", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Compare two commits", - "scope": "repos", - "id": "compareCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/compare/{base}...{head}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. 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 response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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\n**Working with large comparisons**\n\nTo process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"[Traversing with pagination](/rest/guides/traversing-with-pagination).\"\n\nWhen calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/rest/reference/repos#compare-two-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/compare/master...topic\",\"html_url\":\"https://github.com/octocat/Hello-World/compare/master...topic\",\"permalink_url\":\"https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17\",\"diff_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.patch\",\"base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"merge_base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"status\":\"behind\",\"ahead_by\":1,\"behind_by\":2,\"total_commits\":1,\"commits\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}],\"files\":[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "Compare two commits", - "scope": "repos", - "id": "compareCommitsWithBasehead", - "method": "GET", - "url": "/repos/{owner}/{repo}/compare/{basehead}", - "isDeprecated": false, - "deprecationDate": null, - "description": "The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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\n**Working with large comparisons**\n\nTo process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"[Traversing with pagination](/rest/guides/traversing-with-pagination).\"\n\nWhen calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/commits#compare-two-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "basehead", - "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/compare/master...topic\",\"html_url\":\"https://github.com/octocat/Hello-World/compare/master...topic\",\"permalink_url\":\"https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17\",\"diff_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.patch\",\"base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"merge_base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"status\":\"behind\",\"ahead_by\":1,\"behind_by\":2,\"total_commits\":1,\"commits\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}],\"files\":[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a commit comment", - "scope": "repos", - "id": "createCommitComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/comments#create-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "Relative path of the file to comment on.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "Line index in the diff to comment on.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "line", - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author_association\":\"COLLABORATOR\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create commit signature protection", - "scope": "repos", - "id": "createCommitSignatureProtection", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "isDeprecated": false, - "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-commit-signature-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\"enabled\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a commit status", - "scope": "repos", - "id": "createCommitStatus", - "method": "POST", - "url": "/repos/{owner}/{repo}/statuses/{sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/statuses#create-a-commit-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the status.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["error", "failure", "pending", "success"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_url", - "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the status.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "context", - "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a deploy key", - "scope": "repos", - "id": "createDeployKey", - "method": "POST", - "url": "/repos/{owner}/{repo}/keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can create a read-only deploy key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-deploy-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "A name for the key.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key", - "description": "The contents of the key.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "read_only", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a deployment", - "scope": "repos", - "id": "createDeployment", - "method": "POST", - "url": "/repos/{owner}/{repo}/deployments", - "isDeprecated": false, - "deprecationDate": 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 Enterprise Server 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/enterprise-server@3.2/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-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. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The ref to deploy. This can be a branch, tag, or SHA.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "task", - "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_merge", - "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_contexts", - "description": "The [status](https://docs.github.com/enterprise-server@3.2/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "payload", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "Short description of the deployment.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "transient_environment", - "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "production_environment", - "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}" - } - ] - }, - { - "code": 202, - "description": "Merged branch response", - "examples": [ - { - "data": "{\"message\":\"Auto-merged master into topic-branch on deployment.\"}" - } - ] - }, - { - "code": 409, - "description": "Conflict when there is a merge conflict or the commit's status checks failed", - "examples": null - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a deployment branch policy", - "scope": "repos", - "id": "createDeploymentBranchPolicy", - "method": "POST", - "url": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/deployments/branch-policies#create-deployment-branch-policy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":364662,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=\",\"name\":\"release/*\"}" - }, - { - "data": "{\"id\":364663,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=\",\"name\":\"main\"}" - } - ] - }, - { - "code": 303, - "description": "Response if the same branch name pattern already exists", - "examples": null - }, - { - "code": 404, - "description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a deployment status", - "scope": "repos", - "id": "createDeploymentStatus", - "method": "POST", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-deployment-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the status. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "error", - "failure", - "inactive", - "in_progress", - "queued", - "pending", - "success" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_url", - "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "log_url", - "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the status. The maximum description length is 140 characters.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["production", "staging", "qa"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_url", - "description": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_inactive", - "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://docs.github.com/enterprise-server@3.2/rest/overview/api-previews#enhanced-deployments) custom media type.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"https://test-branch.lab.acme.com\",\"log_url\":\"https://example.com/deployment/42/output\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a repository dispatch event", - "scope": "repos", - "id": "createDispatchEvent", - "method": "POST", - "url": "/repos/{owner}/{repo}/dispatches", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server 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/enterprise-server@3.2/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis endpoint requires write access to the repository by providing either:\n\n - Personal access tokens with `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-repository-dispatch-event", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event_type", - "description": "A custom webhook event name. Must be 100 characters or fewer.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "client_payload", - "description": "JSON payload with extra information about the webhook event that your action or workflow may use.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "client_payload.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a repository for the authenticated user", - "scope": "repos", - "id": "createForAuthenticatedUser", - "method": "POST", - "url": "/user/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.2/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-repository-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "The name of the repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "homepage", - "description": "A URL with more information about the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Whether the repository is private.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_issues", - "description": "Whether issues are enabled.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_projects", - "description": "Whether projects are enabled.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_wiki", - "description": "Whether the wiki is enabled.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_id", - "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_init", - "description": "Whether the repository is initialized with a minimal README.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "gitignore_template", - "description": "The desired language or platform to apply to the .gitignore.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "license_template", - "description": "The license keyword of the open source license for this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_squash_merge", - "description": "Whether to allow squash merges for pull requests.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_merge_commit", - "description": "Whether to allow merge commits for pull requests.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_rebase_merge", - "description": "Whether to allow rebase merges for pull requests.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delete_branch_on_merge", - "description": "Whether to delete head branches when pull requests are merged", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "squash_merge_commit_title", - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_TITLE", "COMMIT_OR_PR_TITLE"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "squash_merge_commit_message", - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_BODY", "COMMIT_MESSAGES", "BLANK"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_commit_title", - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_TITLE", "MERGE_MESSAGE"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_commit_message", - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_BODY", "PR_TITLE", "BLANK"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_downloads", - "description": "Whether downloads are enabled.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "is_template", - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "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\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a fork", - "scope": "repos", - "id": "createFork", - "method": "POST", - "url": "/repos/{owner}/{repo}/forks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-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. 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": "organization", - "description": "Optional parameter to specify the organization name if forking into an organization.", - "in": "BODY", - "type": "string", - "required": false, - "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\"},\"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\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"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\",\"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,\"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,\"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": "Create an organization repository", - "scope": "repos", - "id": "createInOrg", - "method": "POST", - "url": "/orgs/{org}/repos", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/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", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-an-organization-repository", - "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": "name", - "description": "The name of the repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "homepage", - "description": "A URL with more information about the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Whether the repository is private.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["public", "private", "internal"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_issues", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_projects", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_wiki", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "is_template", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_id", - "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_init", - "description": "Pass `true` to create an initial commit with empty README.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "gitignore_template", - "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "license_template", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_squash_merge", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_merge_commit", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_rebase_merge", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delete_branch_on_merge", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "use_squash_pr_title_as_default", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "squash_merge_commit_title", - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_TITLE", "COMMIT_OR_PR_TITLE"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "squash_merge_commit_message", - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_BODY", "COMMIT_MESSAGES", "BLANK"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_commit_title", - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_TITLE", "MERGE_MESSAGE"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_commit_message", - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_BODY", "PR_TITLE", "BLANK"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "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\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" - } - ] - }, - { "code": 403, "description": "Forbidden", "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", - "id": "createOrUpdateEnvironment", - "method": "PUT", - "url": "/repos/{owner}/{repo}/environments/{environment_name}", - "isDeprecated": false, - "deprecationDate": 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 \"[Secrets](/rest/reference/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-or-update-an-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "wait_timer", - "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reviewers", - "description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reviewers[].type", - "description": "The type of reviewer.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["User", "Team"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reviewers[].id", - "description": "The id of the user or team who can review the deployment", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_branch_policy", - "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_branch_policy.protected_branches", - "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_branch_policy.custom_branch_policies", - "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\",\"protection_rules\":[{\"id\":3736,\"node_id\":\"MDQ6R2F0ZTM3MzY=\",\"type\":\"wait_timer\",\"wait_timer\":30},{\"id\":3755,\"node_id\":\"MDQ6R2F0ZTM3NTU=\",\"type\":\"required_reviewers\",\"reviewers\":[{\"type\":\"User\",\"reviewer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}},{\"type\":\"Team\",\"reviewer\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]},{\"id\":3756,\"node_id\":\"MDQ6R2F0ZTM3NTY=\",\"type\":\"branch_policy\"}],\"deployment_branch_policy\":{\"protected_branches\":false,\"custom_branch_policies\":true}}" - } - ] - }, - { - "code": 422, - "description": "Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create or update file contents", - "scope": "repos", - "id": "createOrUpdateFileContents", - "method": "PUT", - "url": "/repos/{owner}/{repo}/contents/{path}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.2/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-or-update-file-contents", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "path parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The commit message.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The new file content, using Base64 encoding.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer", - "description": "The person that committed the file. Default: the authenticated user.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.name", - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.email", - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.date", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author", - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.name", - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.email", - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.date", - "description": "", - "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": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"a56507ed892d05a37c6d6128c260937ea4d287bd\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"node_id\":\"MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\",\"sha\":\"9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6\",\"sha\":\"da5a433788da5c255edad7979b328b67d79f53f6\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a GitHub Enterprise Server Pages site", - "scope": "repos", - "id": "createPagesSite", - "method": "POST", - "url": "/repos/{owner}/{repo}/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "Configures a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/pages#create-a-github-pages-site", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "build_type", - "description": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["legacy", "workflow"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source", - "description": "The source branch and directory used to publish your Pages site.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source.branch", - "description": "The repository branch used to publish your site's source files.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source.path", - "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["/", "/docs"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages\",\"status\":\"built\",\"cname\":\"developer.github.com\",\"custom_404\":false,\"html_url\":\"https://developer.github.com\",\"source\":{\"branch\":\"master\",\"path\":\"/\"},\"public\":true,\"https_certificate\":{\"state\":\"approved\",\"description\":\"Certificate is approved\",\"domains\":[\"developer.github.com\"],\"expires_at\":\"2021-05-22\"},\"https_enforced\":true}" - } - ] - }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a release", - "scope": "repos", - "id": "createRelease", - "method": "POST", - "url": "/repos/{owner}/{repo}/releases", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag_name", - "description": "The name of the tag.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_commitish", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the release.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "Text describing the contents of the tag.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "draft", - "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "prerelease", - "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a repository using a template", - "scope": "repos", - "id": "createUsingTemplate", - "method": "POST", - "url": "/repos/{template_owner}/{template_repo}/generate", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/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/enterprise-server@3.2/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", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-repository-using-a-template", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "template_owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "template_repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the new repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the new repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "include_all_branches", - "description": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Either `true` to create a new private repository or `false` to create a new public one.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "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\",\"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,\"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\"},\"template_repository\":{}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a repository webhook", - "scope": "repos", - "id": "createWebhook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repos#create-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-hook-config-params).", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "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/enterprise-server@3.2/webhooks/event-payloads) the hook is triggered for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"deliveries_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":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": "Decline a repository invitation", - "scope": "repos", - "id": "declineInvitation", - "method": "DELETE", - "url": "/user/repository_invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/invitations#decline-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null } - ], - "renamed": { - "before": { "scope": "repos", "id": "declineInvitation" }, - "after": { - "scope": "repos", - "id": "declineInvitationForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Decline a repository invitation", - "scope": "repos", - "id": "declineInvitationForAuthenticatedUser", - "method": "DELETE", - "url": "/user/repository_invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/invitations#decline-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a repository", - "scope": "repos", - "id": "delete", - "method": "DELETE", - "url": "/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 307, "description": "Temporary Redirect", "examples": null }, - { - "code": 403, - "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", - "examples": [ - { - "data": "{\"message\":\"Organization members cannot delete repositories.\",\"documentation_url\":\"https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-a-repository\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete access restrictions", - "scope": "repos", - "id": "deleteAccessRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "isDeprecated": false, - "deprecationDate": 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\nDisables the ability to restrict who can push to this branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete admin branch protection", - "scope": "repos", - "id": "deleteAdminBranchProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "isDeprecated": false, - "deprecationDate": 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\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-admin-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an environment", - "scope": "repos", - "id": "deleteAnEnvironment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/environments/{environment_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "You must authenticate using an access token with the repo scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-an-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Default response", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete branch protection", - "scope": "repos", - "id": "deleteBranchProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a commit comment", - "scope": "repos", - "id": "deleteCommitComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/comments#delete-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete commit signature protection", - "scope": "repos", - "id": "deleteCommitSignatureProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "isDeprecated": false, - "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-commit-signature-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a deploy key", - "scope": "repos", - "id": "deleteDeployKey", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-a-deploy-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "The unique identifier of the key.", - "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 a deployment", - "scope": "repos", - "id": "deleteDeployment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-a-deployment-status).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-a-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. 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": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a deployment branch policy", - "scope": "repos", - "id": "deleteDeploymentBranchPolicy", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/deployments/branch-policies#delete-deployment-branch-policy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch_policy_id", - "description": "The unique identifier of the branch policy.", - "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 a file", - "scope": "repos", - "id": "deleteFile", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/contents/{path}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.2/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-a-file", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "path parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The commit message.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "The blob SHA of the file being deleted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer", - "description": "object containing information about the committer.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.email", - "description": "The email of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author", - "description": "object containing information about the author.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.email", - "description": "The email of the author (or committer) of the commit", - "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": "{\"content\":null,\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a repository invitation", - "scope": "repos", - "id": "deleteInvitation", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/invitations#delete-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "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 a GitHub Enterprise Server Pages site", - "scope": "repos", - "id": "deletePagesSite", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/pages#delete-a-github-pages-site", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete pull request review protection", - "scope": "repos", - "id": "deletePullRequestReviewProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-pull-request-review-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a release", - "scope": "repos", - "id": "deleteRelease", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access to the repository can delete a release.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a release asset", - "scope": "repos", - "id": "deleteReleaseAsset", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#delete-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "asset_id", - "description": "The unique identifier of the asset.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a repository webhook", - "scope": "repos", - "id": "deleteWebhook", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repos#delete-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Download a repository archive (tar)", - "scope": "repos", - "id": "downloadTarballArchive", - "method": "GET", - "url": "/repos/{owner}/{repo}/tarball/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#download-a-repository-archive", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Download a repository archive (zip)", - "scope": "repos", - "id": "downloadZipballArchive", - "method": "GET", - "url": "/repos/{owner}/{repo}/zipball/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#download-a-repository-archive", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get a repository", - "scope": "repos", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.\n\nThe `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":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,\"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\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"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\",\"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,\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}" - }, - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"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\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"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\",\"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,\"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,\"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_of_conduct\":{\"key\":\"other\",\"name\":\"Other\",\"html_url\":\"https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md\",\"url\":\"https://api.github.com/repos/github/docs/community/code_of_conduct\"}}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get access restrictions", - "scope": "repos", - "id": "getAccessRestrictions", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "isDeprecated": false, - "deprecationDate": 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 who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get admin branch protection", - "scope": "repos", - "id": "getAdminBranchProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-admin-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List environments", - "scope": "repos", - "id": "getAllEnvironments", - "method": "GET", - "url": "/repos/{owner}/{repo}/environments", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/deployments/environments#list-environments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"environments\":[{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\",\"protection_rules\":[{\"id\":3736,\"node_id\":\"MDQ6R2F0ZTM3MzY=\",\"type\":\"wait_timer\",\"wait_timer\":30},{\"id\":3755,\"node_id\":\"MDQ6R2F0ZTM3NTU=\",\"type\":\"required_reviewers\",\"reviewers\":[{\"type\":\"User\",\"reviewer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}},{\"type\":\"Team\",\"reviewer\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]},{\"id\":3756,\"node_id\":\"MDQ6R2F0ZTM3NTY=\",\"type\":\"branch_policy\"}],\"deployment_branch_policy\":{\"protected_branches\":false,\"custom_branch_policies\":true}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get all status check contexts", - "scope": "repos", - "id": "getAllStatusCheckContexts", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-all-status-check-contexts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all repository topics", - "scope": "repos", - "id": "getAllTopics", - "method": "GET", - "url": "/repos/{owner}/{repo}/topics", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-all-repository-topics", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "Get apps with access to the protected branch", - "scope": "repos", - "id": "getAppsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-apps-with-access-to-the-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a branch", - "scope": "repos", - "id": "getBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"main\",\"commit\":{\"sha\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"node_id\":\"MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk\",\"commit\":{\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\",\"date\":\"2012-03-06T23:06:50Z\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\",\"date\":\"2012-03-06T23:06:50Z\"},\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"tree\":{\"sha\":\"b4eecafa9be2f2006ce1b709d6857b07069b4608\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608\"},\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"comment_count\":77,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments\",\"author\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"sha\":\"553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\"},{\"sha\":\"762941318ee16e59dabbacb1b4049eec22f0d303\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303\"}]},\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/branches/main\",\"html\":\"https://github.com/octocat/Hello-World/tree/main\"},\"protected\":false,\"protection\":{\"enabled\":false,\"required_status_checks\":{\"enforcement_level\":\"off\",\"contexts\":[],\"checks\":[]}},\"protection_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/main/protection\"}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get branch protection", - "scope": "repos", - "id": "getBranchProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\",\"enforcement_level\":\"non_admins\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true},\"required_conversation_resolution\":{\"enabled\":true}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the weekly commit activity", - "scope": "repos", - "id": "getCodeFrequencyStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/code_frequency", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/metrics/statistics#get-the-weekly-commit-activity", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", - "examples": [{ "data": "[[1302998400,1124,-435]]" }] - }, - { "code": 202, "description": "Accepted", "examples": null }, - { - "code": 204, - "description": "A header with no content is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get repository permissions for a user", - "scope": "repos", - "id": "getCollaboratorPermissionLevel", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "isDeprecated": false, - "deprecationDate": null, - "description": "Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/collaborators#get-repository-permissions-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. 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 - } - ], - "responses": [ - { - "code": 200, - "description": "if user has admin permissions", - "examples": [ - { - "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the combined status for a specific reference", - "scope": "repos", - "id": "getCombinedStatusForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/status", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/statuses#get-the-combined-status-for-a-specific-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"state\":\"success\",\"statuses\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\"},{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"id\":2,\"node_id\":\"MDY6U3RhdHVzMg==\",\"state\":\"success\",\"description\":\"Testing has completed successfully\",\"target_url\":\"https://ci.example.com/2000/output\",\"context\":\"security/brakeman\",\"created_at\":\"2012-08-20T01:19:13Z\",\"updated_at\":\"2012-08-20T01:19:13Z\"}],\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"total_count\":2,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a commit", - "scope": "repos", - "id": "getCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/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/enterprise-server@3.2/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 her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/commits#get-a-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}],\"stats\":{\"additions\":104,\"deletions\":4,\"total\":108},\"files\":[{\"filename\":\"file1.txt\",\"additions\":10,\"deletions\":2,\"changes\":12,\"status\":\"modified\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"blob_url\":\"https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"patch\":\"@@ -29,7 +29,7 @@\\n.....\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 500, "description": "Internal Error", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the last year of commit activity", - "scope": "repos", - "id": "getCommitActivityStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/commit_activity", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/metrics/statistics#get-the-last-year-of-commit-activity", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"days\":[0,3,26,20,39,1,0],\"total\":89,\"week\":1336280400}]" - } - ] - }, - { "code": 202, "description": "Accepted", "examples": null }, - { - "code": 204, - "description": "A header with no content is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a commit comment", - "scope": "repos", - "id": "getCommitComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/comments#get-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author_association\":\"COLLABORATOR\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get commit signature protection", - "scope": "repos", - "id": "getCommitSignatureProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "isDeprecated": false, - "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-commit-signature-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\"enabled\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get repository content", - "scope": "repos", - "id": "getContent", - "method": "GET", - "url": "/repos/{owner}/{repo}/contents/{path}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-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/enterprise-server@3.2/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.2/rest/reference/git#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* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-repository-content", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "path parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" - }, - { - "data": "[{\"type\":\"file\",\"size\":625,\"name\":\"octokit.rb\",\"path\":\"lib/octokit.rb\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb\",\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"octokit\",\"path\":\"lib/octokit\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\"}}]" - }, - { - "data": "{\"type\":\"symlink\",\"target\":\"/path/to/symlink/target\",\"size\":23,\"name\":\"some-symlink\",\"path\":\"bin/some-symlink\",\"sha\":\"452a98979c88e093d682cab404a3ec82babebb48\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\"}}" - }, - { - "data": "{\"type\":\"submodule\",\"submodule_git_url\":\"git://github.com/jquery/qunit.git\",\"size\":0,\"name\":\"qunit\",\"path\":\"test/qunit\",\"sha\":\"6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"url\":\"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\"git_url\":\"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"html_url\":\"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"download_url\":null,\"_links\":{\"git\":\"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"self\":\"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\"html\":\"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\"}}" - } - ] - }, - { "code": 302, "description": "Found", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all contributor commit activity", - "scope": "repos", - "id": "getContributorsStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/contributors", - "isDeprecated": false, - "deprecationDate": 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", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/metrics/statistics#get-all-contributor-commit-activity", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"total\":135,\"weeks\":[{\"w\":1367712000,\"a\":6898,\"d\":77,\"c\":10}]}]" - } - ] - }, - { "code": 202, "description": "Accepted", "examples": null }, - { - "code": 204, - "description": "A header with no content is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a deploy key", - "scope": "repos", - "id": "getDeployKey", - "method": "GET", - "url": "/repos/{owner}/{repo}/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-deploy-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "The unique identifier of the key.", - "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\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a deployment", - "scope": "repos", - "id": "getDeployment", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-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. 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": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a deployment branch policy", - "scope": "repos", - "id": "getDeploymentBranchPolicy", - "method": "GET", - "url": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/deployments/branch-policies#get-deployment-branch-policy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch_policy_id", - "description": "The unique identifier of the branch policy.", - "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\":364662,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=\",\"name\":\"release/*\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a deployment status", - "scope": "repos", - "id": "getDeploymentStatus", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with pull access can view a deployment status for a deployment:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-deployment-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"https://test-branch.lab.acme.com\",\"log_url\":\"https://example.com/deployment/42/output\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an environment", - "scope": "repos", - "id": "getEnvironment", - "method": "GET", - "url": "/repos/{owner}/{repo}/environments/{environment_name}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-an-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\",\"protection_rules\":[{\"id\":3736,\"node_id\":\"MDQ6R2F0ZTM3MzY=\",\"type\":\"wait_timer\",\"wait_timer\":30},{\"id\":3755,\"node_id\":\"MDQ6R2F0ZTM3NTU=\",\"type\":\"required_reviewers\",\"reviewers\":[{\"type\":\"User\",\"reviewer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}},{\"type\":\"Team\",\"reviewer\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]},{\"id\":3756,\"node_id\":\"MDQ6R2F0ZTM3NTY=\",\"type\":\"branch_policy\"}],\"deployment_branch_policy\":{\"protected_branches\":false,\"custom_branch_policies\":true}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get latest Pages build", - "scope": "repos", - "id": "getLatestPagesBuild", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds/latest", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/pages#get-latest-pages-build", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the latest release", - "scope": "repos", - "id": "getLatestRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/latest", - "isDeprecated": false, - "deprecationDate": null, - "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-the-latest-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/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}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a GitHub Enterprise Server Pages site", - "scope": "repos", - "id": "getPages", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/pages#get-a-github-pages-site", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages\",\"status\":\"built\",\"cname\":\"developer.github.com\",\"custom_404\":false,\"html_url\":\"https://developer.github.com\",\"source\":{\"branch\":\"master\",\"path\":\"/\"},\"public\":true,\"https_certificate\":{\"state\":\"approved\",\"description\":\"Certificate is approved\",\"domains\":[\"developer.github.com\"],\"expires_at\":\"2021-05-22\"},\"https_enforced\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get GitHub Enterprise Server Pages build", - "scope": "repos", - "id": "getPagesBuild", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/pages#get-github-pages-build", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "build_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the weekly commit count", - "scope": "repos", - "id": "getParticipationStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/participation", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/metrics/statistics#get-the-weekly-commit-count", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The array order is oldest week (index 0) to most recent week.", - "examples": [ - { - "data": "{\"all\":[11,21,15,2,8,1,8,23,17,21,11,10,33,91,38,34,22,23,32,3,43,87,71,18,13,5,13,16,66,27,12,45,110,117,13,8,18,9,19,26,39,12,20,31,46,91,45,10,24,9,29,7],\"owner\":[3,2,3,0,2,0,5,14,7,9,1,5,0,48,19,2,0,1,10,2,23,40,35,8,8,2,10,6,30,0,2,9,53,104,3,3,10,4,7,11,21,4,4,22,26,63,11,2,14,1,10,3]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get pull request review protection", - "scope": "repos", - "id": "getPullRequestReviewProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-pull-request-review-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the hourly commit count for each day", - "scope": "repos", - "id": "getPunchCardStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/punch_card", - "isDeprecated": false, - "deprecationDate": null, - "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/statistics/repos#get-the-hourly-commit-count-for-each-day", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", - "examples": [{ "data": "[[0,0,5],[0,1,43],[0,2,21]]" }] - }, - { - "code": 204, - "description": "A header with no content is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a repository README", - "scope": "repos", - "id": "getReadme", - "method": "GET", - "url": "/repos/{owner}/{repo}/readme", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-repository-readme", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a repository README for a directory", - "scope": "repos", - "id": "getReadmeInDirectory", - "method": "GET", - "url": "/repos/{owner}/{repo}/readme/{dir}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-repository-directory-readme", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dir", - "description": "The alternate path to look for a README file", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a release", - "scope": "repos", - "id": "getRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#hypermedia).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#hypermedia).", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a release asset", - "scope": "repos", - "id": "getReleaseAsset", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "asset_id", - "description": "The unique identifier of the asset.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 302, "description": "Found", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a release by tag name", - "scope": "repos", - "id": "getReleaseByTag", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/tags/{tag}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get a published release with the specified tag.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-a-release-by-tag-name", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag", - "description": "tag parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get status checks protection", - "scope": "repos", - "id": "getStatusChecksProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#get-status-checks-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get teams with access to the protected branch", - "scope": "repos", - "id": "getTeamsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "deprecationDate": 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 teams who have push access to this branch. The list includes child teams.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-teams-with-access-to-the-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get users with access to the protected branch", - "scope": "repos", - "id": "getUsersWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "isDeprecated": false, - "deprecationDate": 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 people who have push access to this branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-users-with-access-to-the-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a repository webhook", - "scope": "repos", - "id": "getWebhook", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repos#get-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"deliveries_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a webhook configuration for a repository", - "scope": "repos", - "id": "getWebhookConfigForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "isDeprecated": false, - "deprecationDate": 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/reference/orgs#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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a delivery for a repository webhook", - "scope": "repos", - "id": "getWebhookDelivery", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a delivery for a webhook configured in a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delivery_id", - "description": "", - "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\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"url\":\"https://www.example.com\",\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List branches", - "scope": "repos", - "id": "listBranches", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-branches", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "protected", - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"name\":\"master\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"protected\":true,\"protection\":{\"required_status_checks\":{\"enforcement_level\":\"non_admins\",\"contexts\":[\"ci-test\",\"linter\"]}},\"protection_url\":\"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List branches for HEAD commit", - "scope": "repos", - "id": "listBranchesForHeadCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "isDeprecated": false, - "deprecationDate": 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\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/commits#list-branches-for-head-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit.", - "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\":\"branch_5\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"protected\":false}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List repository collaborators", - "scope": "repos", - "id": "listCollaborators", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/collaborators#list-repository-collaborators", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "affiliation", - "description": "Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["outside", "direct", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["pull", "triage", "push", "maintain", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"permissions\":{\"pull\":true,\"push\":true,\"admin\":false}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List commit comments", - "scope": "repos", - "id": "listCommentsForCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Use the `:commit_sha` to specify the commit that will have its comments listed.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/comments#list-commit-comments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List commit comments for a repository", - "scope": "repos", - "id": "listCommitCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Commit Comments use [these custom media types](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types/).\n\nComments are ordered by ascending ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/comments#list-commit-comments-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List commit statuses for a reference", - "scope": "repos", - "id": "listCommitStatusesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/statuses#list-commit-statuses-for-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null } - ], - "renamed": null - }, - { - "name": "List commits", - "scope": "repos", - "id": "listCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/commits#list-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "Only commits containing this file path will be returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author", - "description": "GitHub login or email address by which to filter by commit author.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}]" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository contributors", - "scope": "repos", - "id": "listContributors", - "method": "GET", - "url": "/repos/{owner}/{repo}/contributors", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-repository-contributors", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "anon", - "description": "Set to `1` or `true` to include anonymous contributors in results.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if repository contains content", - "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,\"contributions\":32}]" - } - ] - }, - { - "code": 204, - "description": "Response if repository is empty", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List deploy keys", - "scope": "repos", - "id": "listDeployKeys", - "method": "GET", - "url": "/repos/{owner}/{repo}/keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-deploy-keys", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": [{ "data": "{}" }] } - ], - "renamed": null - }, - { - "name": "List deployment branch policies", - "scope": "repos", - "id": "listDeploymentBranchPolicies", - "method": "GET", - "url": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/deployments/branch-policies#list-deployment-branch-policies", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"branch_policies\":[{\"id\":361471,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=\",\"name\":\"release/*\"},{\"id\":361472,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=\",\"name\":\"main\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List deployment statuses", - "scope": "repos", - "id": "listDeploymentStatuses", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with pull access can view deployment statuses for a deployment:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-deployment-statuses", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"https://test-branch.lab.acme.com\",\"log_url\":\"https://example.com/deployment/42/output\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List deployments", - "scope": "repos", - "id": "listDeployments", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Simple filtering of deployments is available via query parameters:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-deployments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "The SHA recorded at creation time.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the ref. This can be a branch, tag, or SHA.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "task", - "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories for the authenticated user", - "scope": "repos", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists repositories 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-repositories-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "visibility", - "description": "Limit results to repositories with the specified visibility.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "public", "private"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "affiliation", - "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "type", - "description": "Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "owner", "public", "private", "member"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "pushed", "full_name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List organization repositories", - "scope": "repos", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists repositories for the specified organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-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": "type", - "description": "Specifies the types of repositories you want returned. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "all", - "public", - "private", - "forks", - "sources", - "member", - "internal" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "pushed", "full_name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories for a user", - "scope": "repos", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-repositories-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "type", - "description": "Limit results to repositories of the specified type.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "owner", "member"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "pushed", "full_name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List forks", - "scope": "repos", - "id": "listForks", - "method": "GET", - "url": "/repos/{owner}/{repo}/forks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-forks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The sort order. `stargazers` will sort by star count.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["newest", "oldest", "stargazers", "watchers"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":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\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository invitations", - "scope": "repos", - "id": "listInvitations", - "method": "GET", - "url": "/repos/{owner}/{repo}/invitations", - "isDeprecated": false, - "deprecationDate": null, - "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/invitations#list-repository-invitations", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\",\"node_id\":\"MDQ6VXNlcjE=\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository invitations for the authenticated user", - "scope": "repos", - "id": "listInvitationsForAuthenticatedUser", - "method": "GET", - "url": "/user/repository_invitations", - "isDeprecated": false, - "deprecationDate": null, - "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\",\"node_id\":\"MDQ6VXNlcjE=\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository languages", - "scope": "repos", - "id": "listLanguages", - "method": "GET", - "url": "/repos/{owner}/{repo}/languages", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-repository-languages", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "{\"C\":78769,\"Python\":7769}" }] - } - ], - "renamed": null - }, - { - "name": "List GitHub Enterprise Server Pages builds", - "scope": "repos", - "id": "listPagesBuilds", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/pages#list-github-pages-builds", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public repositories", - "scope": "repos", - "id": "listPublic", - "method": "GET", - "url": "/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-public-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "A repository ID. Only return repositories with an ID greater than this ID.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Specifies the types of repositories to return. This endpoint will only list repositories available to all users on the enterprise.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "public"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List pull requests associated with a commit", - "scope": "repos", - "id": "listPullRequestsAssociatedWithCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/commits#list-pull-requests-associated-with-a-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List release assets", - "scope": "repos", - "id": "listReleaseAssets", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-release-assets", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/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}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List releases", - "scope": "repos", - "id": "listReleases", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases", - "isDeprecated": false, - "deprecationDate": null, - "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-releases", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/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\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository tags", - "scope": "repos", - "id": "listTags", - "method": "GET", - "url": "/repos/{owner}/{repo}/tags", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-repository-tags", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"name\":\"v0.1\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"zipball_url\":\"https://github.com/octocat/Hello-World/zipball/v0.1\",\"tarball_url\":\"https://github.com/octocat/Hello-World/tarball/v0.1\",\"node_id\":\"MDQ6VXNlcjE=\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository teams", - "scope": "repos", - "id": "listTeams", - "method": "GET", - "url": "/repos/{owner}/{repo}/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-repository-teams", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List deliveries for a repository webhook", - "scope": "repos", - "id": "listWebhookDeliveries", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a list of webhook deliveries for a webhook configured in a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "cursor", - "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456},{\"id\":123456789,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-04T00:57:16Z\",\"redelivery\":true,\"duration\":0.28,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456}]" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List repository webhooks", - "scope": "repos", - "id": "listWebhooks", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repos#list-repository-webhooks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"deliveries_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Merge a branch", - "scope": "repos", - "id": "merge", - "method": "POST", - "url": "/repos/{owner}/{repo}/merges", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#merge-a-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "The name of the base branch that the head will be merged into.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "The head to merge. This can be a branch name or a commit SHA1.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_message", - "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Successful Response (The resulting merge commit)", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}],\"stats\":{\"additions\":104,\"deletions\":4,\"total\":108},\"files\":[{\"filename\":\"file1.txt\",\"additions\":10,\"deletions\":2,\"changes\":12,\"status\":\"modified\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"blob_url\":\"https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"patch\":\"@@ -29,7 +29,7 @@\\n.....\"}]}" - } - ] - }, - { - "code": 204, - "description": "Response when already merged", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found when the base or head does not exist", - "examples": null - }, - { - "code": 409, - "description": "Conflict when there is a merge conflict", - "examples": null - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Ping a repository webhook", - "scope": "repos", - "id": "pingWebhook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "isDeprecated": false, - "deprecationDate": null, - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.2/webhooks/#ping-event) to be sent to the hook.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repos#ping-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Redeliver a delivery for a repository webhook", - "scope": "repos", - "id": "redeliverWebhookDelivery", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Redeliver a webhook delivery for a webhook configured in a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delivery_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove app access restrictions", - "scope": "repos", - "id": "removeAppAccessRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#remove-app-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "apps", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove a repository collaborator", - "scope": "repos", - "id": "removeCollaborator", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/collaborators#remove-a-repository-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove status check contexts", - "scope": "repos", - "id": "removeStatusCheckContexts", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#remove-status-check-contexts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove status check protection", - "scope": "repos", - "id": "removeStatusCheckProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#remove-status-check-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove team access restrictions", - "scope": "repos", - "id": "removeTeamAccessRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "deprecationDate": 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 a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#remove-team-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "teams", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove user access restrictions", - "scope": "repos", - "id": "removeUserAccessRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "isDeprecated": false, - "deprecationDate": 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 a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#remove-user-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "users", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Rename a branch", - "scope": "repos", - "id": "renameBranch", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/rename", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#rename-a-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "new_name", - "description": "The new name of the branch.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"master\",\"commit\":{\"sha\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"node_id\":\"MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==\",\"commit\":{\"author\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"tree\":{\"sha\":\"b4eecafa9be2f2006ce1b709d6857b07069b4608\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608\"},\"committer\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null},\"comment_count\":0},\"author\":{\"gravatar_id\":\"\",\"avatar_url\":\"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png\",\"url\":\"https://api.github.com/users/octocat\",\"id\":583231,\"login\":\"octocat\",\"node_id\":\"MDQ6VXNlcjE=\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"parents\":[{\"sha\":\"553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\"},{\"sha\":\"762941318ee16e59dabbacb1b4049eec22f0d303\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303\"}],\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"committer\":{\"gravatar_id\":\"\",\"avatar_url\":\"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png\",\"url\":\"https://api.github.com/users/octocat\",\"id\":583231,\"login\":\"octocat\",\"node_id\":\"MDQ6VXNlcjE=\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\"},\"_links\":{\"html\":\"https://github.com/octocat/Hello-World/tree/master\",\"self\":\"https://api.github.com/repos/octocat/Hello-World/branches/master\"},\"protected\":true,\"protection\":{\"required_status_checks\":{\"enforcement_level\":\"non_admins\",\"contexts\":[\"ci-test\",\"linter\"]}},\"protection_url\":\"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"}" - } - ] - }, - { "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": "Replace all repository topics", - "scope": "repos", - "id": "replaceAllTopics", - "method": "PUT", - "url": "/repos/{owner}/{repo}/topics", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#replace-all-repository-topics", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "names", - "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Request a GitHub Enterprise Server Pages build", - "scope": "repos", - "id": "requestPagesBuild", - "method": "POST", - "url": "/repos/{owner}/{repo}/pages/builds", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/pages#request-a-github-pages-build", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/latest\",\"status\":\"queued\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set admin branch protection", - "scope": "repos", - "id": "setAdminBranchProtection", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "isDeprecated": false, - "deprecationDate": 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\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#set-admin-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set app access restrictions", - "scope": "repos", - "id": "setAppAccessRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#set-app-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "apps", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Set status check contexts", - "scope": "repos", - "id": "setStatusCheckContexts", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#set-status-check-contexts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Set team access restrictions", - "scope": "repos", - "id": "setTeamAccessRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "deprecationDate": 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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#set-team-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "teams", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Set user access restrictions", - "scope": "repos", - "id": "setUserAccessRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "isDeprecated": false, - "deprecationDate": 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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#set-user-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "users", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Test the push repository webhook", - "scope": "repos", - "id": "testPushWebhook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "isDeprecated": false, - "deprecationDate": null, - "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repos#test-the-push-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Transfer a repository", - "scope": "repos", - "id": "transfer", - "method": "POST", - "url": "/repos/{owner}/{repo}/transfer", - "isDeprecated": false, - "deprecationDate": 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/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#transfer-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "new_owner", - "description": "The username or organization name the repository will be transferred to.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_ids", - "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "in": "BODY", - "type": "integer[]", - "required": false, - "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\",\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"subscribers_count\":42,\"network_count\":0}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a repository", - "scope": "repos", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#replace-all-repository-topics) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos/#update-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "homepage", - "description": "A URL with more information about the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["public", "private", "internal"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis", - "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.2/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.advanced_security", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.advanced_security.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning", - "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning_push_protection", - "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning_push_protection.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_issues", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_projects", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_wiki", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "is_template", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "default_branch", - "description": "Updates the default branch for this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_squash_merge", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_merge_commit", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_rebase_merge", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delete_branch_on_merge", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_update_branch", - "description": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "use_squash_pr_title_as_default", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "squash_merge_commit_title", - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_TITLE", "COMMIT_OR_PR_TITLE"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "squash_merge_commit_message", - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_BODY", "COMMIT_MESSAGES", "BLANK"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_commit_title", - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_TITLE", "MERGE_MESSAGE"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_commit_message", - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_BODY", "PR_TITLE", "BLANK"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "archived", - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_forking", - "description": "Either `true` to allow private forks, or `false` to prevent private forks.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks_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\",\"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,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"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\",\"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,\"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,\"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": 307, "description": "Temporary Redirect", "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": "Update branch protection", - "scope": "repos", - "id": "updateBranchProtection", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "isDeprecated": false, - "deprecationDate": 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\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks", - "description": "Require status checks to pass before merging. Set to `null` to disable.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.strict", - "description": "Require branches to be up to date before merging.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.contexts", - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.checks", - "description": "The list of status checks to require in order to merge into this branch.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.checks[].context", - "description": "The name of the required check", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.checks[].app_id", - "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforce_admins", - "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews", - "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismissal_restrictions", - "description": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismissal_restrictions.users", - "description": "The list of user `login`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismissal_restrictions.teams", - "description": "The list of team `slug`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismissal_restrictions.apps", - "description": "The list of app `slug`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismiss_stale_reviews", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.required_approving_review_count", - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "restrictions", - "description": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "restrictions.users", - "description": "The list of user `login`s with push access", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "restrictions.teams", - "description": "The list of team `slug`s with push access", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "restrictions.apps", - "description": "The list of app `slug`s with push access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_linear_history", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_force_pushes", - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_deletions", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "block_creations", - "description": "If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_conversation_resolution", - "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "The list of status checks to require in order to merge into this branch.", - "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": "{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts\",\"checks\":[{\"context\":\"continuous-integration/travis-ci\",\"app_id\":null}]},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps\",\"users\":[],\"teams\":[],\"apps\":[]},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews\",\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2,\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams\",\"users\":[],\"teams\":[],\"apps\":[]}},\"required_signatures\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures\",\"enabled\":false},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins\",\"enabled\":true},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true},\"block_creations\":{\"enabled\":true},\"required_conversation_resolution\":{\"enabled\":true}}" - } - ] - }, - { "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": "Update a commit comment", - "scope": "repos", - "id": "updateCommitComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/commits/comments#update-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Nice change\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author_association\":\"COLLABORATOR\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a deployment branch policy", - "scope": "repos", - "id": "updateDeploymentBranchPolicy", - "method": "PUT", - "url": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/deployments/branch-policies#update-deployment-branch-policy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch_policy_id", - "description": "The unique identifier of the branch policy.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":364662,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=\",\"name\":\"release/*\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update information about a GitHub Enterprise Server Pages site", - "scope": "repos", - "id": "updateInformationAboutPagesSite", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/pages#update-information-about-a-github-pages-site", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "cname", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "https_enforced", - "description": "Specify whether HTTPS should be enforced for the repository.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "public", - "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "build_type", - "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["legacy", "workflow"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a repository invitation", - "scope": "repos", - "id": "updateInvitation", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/collaborators/invitations#update-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions", - "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "maintain", "triage", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"expired\":false,\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update pull request review protection", - "scope": "repos", - "id": "updatePullRequestReviewProtection", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "isDeprecated": false, - "deprecationDate": 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\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-pull-request-review-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissal_restrictions", - "description": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissal_restrictions.users", - "description": "The list of user `login`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissal_restrictions.teams", - "description": "The list of team `slug`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissal_restrictions.apps", - "description": "The list of app `slug`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismiss_stale_reviews", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_approving_review_count", - "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a release", - "scope": "repos", - "id": "updateRelease", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access to the repository can edit a release.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag_name", - "description": "The name of the tag.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_commitish", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the release.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "Text describing the contents of the tag.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "draft", - "description": "`true` makes the release a draft, and `false` publishes the release.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "prerelease", - "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/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}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a release asset", - "scope": "repos", - "id": "updateReleaseAsset", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access to the repository can edit a release asset.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "asset_id", - "description": "The unique identifier of the asset.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The file name of the asset.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "label", - "description": "An alternate short description of the asset. Used in place of the filename.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "", - "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": "{\"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}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update status check protection", - "scope": "repos", - "id": "updateStatusCheckProtection", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "isDeprecated": false, - "deprecationDate": 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\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#update-status-check-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "strict", - "description": "Require branches to be up to date before merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "The list of status checks to require in order to merge into this branch", - "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": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a repository webhook", - "scope": "repos", - "id": "updateWebhook", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repos#update-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-hook-config-params).", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "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/enterprise-server@3.2/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "add_events", - "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "remove_events", - "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"deliveries_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":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": "Update a webhook configuration for a repository", - "scope": "repos", - "id": "updateWebhookConfigForRepo", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "isDeprecated": false, - "deprecationDate": 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/reference/orgs#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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Upload a release asset", - "scope": "repos", - "id": "uploadReleaseAsset", - "method": "POST", - "url": "{origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint makes use of [a Hypermedia relation](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/reference/repos#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 Enterprise Server 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 Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/enterprise-server@3.2/rest/reference/repos#list-assets-for-a-release)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\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/enterprise-server@3.2/rest/reference/repos#upload-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "label", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "data", - "description": "The raw file data", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint", - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response for successful upload", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { - "code": 422, - "description": "Response if you upload an asset with the same filename as another uploaded asset", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Search code", - "scope": "search", - "id": "code", - "method": "GET", - "url": "/search/code", - "isDeprecated": false, - "deprecationDate": null, - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/reference/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\n#### Considerations 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/search#search-code", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.2/rest/reference/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-server@3.2/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.2/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["indexed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":7,\"incomplete_results\":false,\"items\":[{\"name\":\"classes.js\",\"path\":\"src/attributes/classes.js\",\"sha\":\"d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\"url\":\"https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4\",\"git_url\":\"https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\"html_url\":\"https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js\",\"repository\":{\"id\":167174,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxNjcxNzQ=\",\"name\":\"jquery\",\"full_name\":\"jquery/jquery\",\"owner\":{\"login\":\"jquery\",\"id\":70142,\"node_id\":\"MDQ6VXNlcjcwMTQy\",\"avatar_url\":\"https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/jquery\",\"html_url\":\"https://github.com/jquery\",\"followers_url\":\"https://api.github.com/users/jquery/followers\",\"following_url\":\"https://api.github.com/users/jquery/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/jquery/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/jquery/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/jquery/subscriptions\",\"organizations_url\":\"https://api.github.com/users/jquery/orgs\",\"repos_url\":\"https://api.github.com/users/jquery/repos\",\"events_url\":\"https://api.github.com/users/jquery/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/jquery/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/jquery/jquery\",\"description\":\"jQuery JavaScript Library\",\"fork\":false,\"url\":\"https://api.github.com/repos/jquery/jquery\",\"forks_url\":\"https://api.github.com/repos/jquery/jquery/forks\",\"keys_url\":\"https://api.github.com/repos/jquery/jquery/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/jquery/jquery/teams\",\"hooks_url\":\"https://api.github.com/repos/jquery/jquery/hooks\",\"issue_events_url\":\"https://api.github.com/repos/jquery/jquery/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/jquery/jquery/events\",\"assignees_url\":\"https://api.github.com/repos/jquery/jquery/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/jquery/jquery/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/jquery/jquery/tags\",\"blobs_url\":\"https://api.github.com/repos/jquery/jquery/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/jquery/jquery/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/jquery/jquery/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/jquery/jquery/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/jquery/jquery/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/jquery/jquery/languages\",\"stargazers_url\":\"https://api.github.com/repos/jquery/jquery/stargazers\",\"contributors_url\":\"https://api.github.com/repos/jquery/jquery/contributors\",\"subscribers_url\":\"https://api.github.com/repos/jquery/jquery/subscribers\",\"subscription_url\":\"https://api.github.com/repos/jquery/jquery/subscription\",\"commits_url\":\"https://api.github.com/repos/jquery/jquery/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/jquery/jquery/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/jquery/jquery/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/jquery/jquery/issues/comments/{number}\",\"contents_url\":\"https://api.github.com/repos/jquery/jquery/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/jquery/jquery/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/jquery/jquery/merges\",\"archive_url\":\"https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/jquery/jquery/downloads\",\"issues_url\":\"https://api.github.com/repos/jquery/jquery/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/jquery/jquery/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/jquery/jquery/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/jquery/jquery/labels{/name}\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\"},\"score\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Search commits", - "scope": "search", - "id": "commits", - "method": "GET", - "url": "/search/commits", - "isDeprecated": false, - "deprecationDate": null, - "description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/reference/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/enterprise-server@3.2/rest/reference/search#search-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.2/rest/reference/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-server@3.2/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.2/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["author-date", "committer-date"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"sha\":\"bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"author\":{\"date\":\"2014-02-04T14:38:36-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"date\":\"2014-02-12T15:18:55-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"message\":\"Create styles.css and updated README\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68\",\"sha\":\"a639e96f9038797fba6e0469f94a4b0cc459fa68\"},\"comment_count\":8},\"author\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"sha\":\"a30c19e3f13765a3b48829788bc1cb8b4e95cee4\"}],\"repository\":{\"id\":1300192,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMzAwMTky\",\"name\":\"Spoon-Knife\",\"full_name\":\"octocat/Spoon-Knife\",\"owner\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Spoon-Knife\",\"description\":\"This repo is for demonstration purposes only.\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife\",\"forks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/forks\",\"keys_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/teams\",\"hooks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/events\",\"assignees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/tags\",\"blobs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/languages\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscription\",\"commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/merges\",\"archive_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/downloads\",\"issues_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/deployments\"},\"score\":1,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\"}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Search issues and pull requests", - "scope": "search", - "id": "issuesAndPullRequests", - "method": "GET", - "url": "/search/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/search#search-issues-and-pull-requests", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.2/rest/reference/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.2/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.2/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":280,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132\",\"repository_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit\",\"labels_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments\",\"events_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events\",\"html_url\":\"https://github.com/batterseapower/pinyin-toolkit/issues/132\",\"id\":35802,\"node_id\":\"MDU6SXNzdWUzNTgwMg==\",\"number\":132,\"title\":\"Line Number Indexes Beyond 20 Not Displayed\",\"user\":{\"login\":\"Nick3C\",\"id\":90254,\"node_id\":\"MDQ6VXNlcjkwMjU0\",\"avatar_url\":\"https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/Nick3C\",\"html_url\":\"https://github.com/Nick3C\",\"followers_url\":\"https://api.github.com/users/Nick3C/followers\",\"following_url\":\"https://api.github.com/users/Nick3C/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/Nick3C/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/Nick3C/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/Nick3C/subscriptions\",\"organizations_url\":\"https://api.github.com/users/Nick3C/orgs\",\"repos_url\":\"https://api.github.com/users/Nick3C/repos\",\"events_url\":\"https://api.github.com/users/Nick3C/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/Nick3C/received_events\",\"type\":\"User\",\"site_admin\":true},\"labels\":[{\"id\":4,\"node_id\":\"MDU6TGFiZWw0\",\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug\",\"name\":\"bug\",\"color\":\"ff0000\"}],\"state\":\"open\",\"assignee\":null,\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"comments\":15,\"created_at\":\"2009-07-12T20:10:41Z\",\"updated_at\":\"2009-07-19T09:23:43Z\",\"closed_at\":null,\"pull_request\":{\"url\":\"https://api/github.com/repos/octocat/Hello-World/pull/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"body\":\"...\",\"score\":1,\"locked\":true,\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Search labels", - "scope": "search", - "id": "labels", - "method": "GET", - "url": "/search/labels", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/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/enterprise-server@3.2/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/search#search-labels", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The id of the repository.", - "in": "QUERY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.2/rest/reference/search#constructing-a-search-query).", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.2/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"incomplete_results\":false,\"items\":[{\"id\":418327088,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODg=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/enhancement\",\"name\":\"enhancement\",\"color\":\"84b6eb\",\"default\":true,\"description\":\"New feature or request.\",\"score\":1},{\"id\":418327086,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODY=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/bug\",\"name\":\"bug\",\"color\":\"ee0701\",\"default\":true,\"description\":\"Something isn't working.\",\"score\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 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": "Search repositories", - "scope": "search", - "id": "repos", - "method": "GET", - "url": "/search/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.\n\nWhen you include the `mercy` preview header, you can also search for multiple topics by adding more `topic:` instances. For example, your query might look like this:\n\n`q=topic:ruby+topic:rails`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/search#search-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.2/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.2/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["stars", "forks", "help-wanted-issues", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":40,\"incomplete_results\":false,\"items\":[{\"id\":3081286,\"node_id\":\"MDEwOlJlcG9zaXRvcnkzMDgxMjg2\",\"name\":\"Tetris\",\"full_name\":\"dtrupenn/Tetris\",\"owner\":{\"login\":\"dtrupenn\",\"id\":872147,\"node_id\":\"MDQ6VXNlcjg3MjE0Nw==\",\"avatar_url\":\"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/dtrupenn\",\"received_events_url\":\"https://api.github.com/users/dtrupenn/received_events\",\"type\":\"User\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"site_admin\":true},\"private\":false,\"html_url\":\"https://github.com/dtrupenn/Tetris\",\"description\":\"A C implementation of Tetris using Pennsim through LC4\",\"fork\":false,\"url\":\"https://api.github.com/repos/dtrupenn/Tetris\",\"created_at\":\"2012-01-01T00:31:50Z\",\"updated_at\":\"2013-01-05T17:58:47Z\",\"pushed_at\":\"2012-01-01T00:37:02Z\",\"homepage\":\"https://github.com\",\"size\":524,\"stargazers_count\":1,\"watchers_count\":1,\"language\":\"Assembly\",\"forks_count\":0,\"open_issues_count\":0,\"master_branch\":\"master\",\"default_branch\":\"master\",\"score\":1,\"archive_url\":\"https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contributors\",\"deployments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/deployments\",\"downloads_url\":\"https://api.github.com/repos/dtrupenn/Tetris/downloads\",\"events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/events\",\"forks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/forks\",\"git_commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}\",\"git_url\":\"git:github.com/dtrupenn/Tetris.git\",\"issue_comment_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/dtrupenn/Tetris/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/dtrupenn/Tetris/languages\",\"merges_url\":\"https://api.github.com/repos/dtrupenn/Tetris/merges\",\"milestones_url\":\"https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/dtrupenn/Tetris/releases{/id}\",\"ssh_url\":\"git@github.com:dtrupenn/Tetris.git\",\"stargazers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/stargazers\",\"statuses_url\":\"https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscribers\",\"subscription_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscription\",\"tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/tags\",\"teams_url\":\"https://api.github.com/repos/dtrupenn/Tetris/teams\",\"trees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}\",\"clone_url\":\"https://github.com/dtrupenn/Tetris.git\",\"mirror_url\":\"git:git.example.com/dtrupenn/Tetris\",\"hooks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/hooks\",\"svn_url\":\"https://svn.github.com/dtrupenn/Tetris\",\"forks\":1,\"open_issues\":1,\"watchers\":1,\"has_issues\":true,\"has_projects\":true,\"has_pages\":true,\"has_wiki\":true,\"has_downloads\":true,\"archived\":true,\"disabled\":true,\"visibility\":\"private\",\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"}}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Search topics", - "scope": "search", - "id": "topics", - "method": "GET", - "url": "/search/topics", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/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/enterprise-server@3.2/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/search#search-topics", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.2/rest/reference/search#constructing-a-search-query).", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":6,\"incomplete_results\":false,\"items\":[{\"name\":\"ruby\",\"display_name\":\"Ruby\",\"short_description\":\"Ruby is a scripting language designed for simplified object-oriented programming.\",\"description\":\"Ruby was developed by Yukihiro \\\"Matz\\\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.\",\"created_by\":\"Yukihiro Matsumoto\",\"released\":\"December 21, 1995\",\"created_at\":\"2016-11-28T22:03:59Z\",\"updated_at\":\"2017-10-30T18:16:32Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"rails\",\"display_name\":\"Rails\",\"short_description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby.\",\"description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.\",\"created_by\":\"David Heinemeier Hansson\",\"released\":\"December 13 2005\",\"created_at\":\"2016-12-09T17:03:50Z\",\"updated_at\":\"2017-10-30T16:20:19Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"python\",\"display_name\":\"Python\",\"short_description\":\"Python is a dynamically typed programming language.\",\"description\":\"Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.\",\"created_by\":\"Guido van Rossum\",\"released\":\"February 20, 1991\",\"created_at\":\"2016-12-07T00:07:02Z\",\"updated_at\":\"2017-10-27T22:45:43Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"jekyll\",\"display_name\":\"Jekyll\",\"short_description\":\"Jekyll is a simple, blog-aware static site generator.\",\"description\":\"Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.\",\"created_by\":\"Tom Preston-Werner\",\"released\":\"2008\",\"created_at\":\"2016-12-16T21:53:08Z\",\"updated_at\":\"2017-10-27T19:00:24Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"sass\",\"display_name\":\"Sass\",\"short_description\":\"Sass is a stable extension to classic CSS.\",\"description\":\"Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.\",\"created_by\":\"Hampton Catlin, Natalie Weizenbaum, Chris Eppstein\",\"released\":\"November 28, 2006\",\"created_at\":\"2016-12-16T21:53:45Z\",\"updated_at\":\"2018-01-16T16:30:40Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"homebrew\",\"display_name\":\"Homebrew\",\"short_description\":\"Homebrew is a package manager for macOS.\",\"description\":\"Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.\",\"created_by\":\"Max Howell\",\"released\":\"2009\",\"created_at\":\"2016-12-17T20:30:44Z\",\"updated_at\":\"2018-02-06T16:14:56Z\",\"featured\":true,\"curated\":true,\"score\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 415, "description": "Preview header missing", "examples": null } - ], - "renamed": null - }, - { - "name": "Search users", - "scope": "search", - "id": "users", - "method": "GET", - "url": "/search/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.2/rest/reference/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/search#search-users", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.2/rest/reference/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-server@3.2/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.2/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["followers", "repositories", "joined"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":12,\"incomplete_results\":false,\"items\":[{\"login\":\"mojombo\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/mojombo\",\"html_url\":\"https://github.com/mojombo\",\"followers_url\":\"https://api.github.com/users/mojombo/followers\",\"subscriptions_url\":\"https://api.github.com/users/mojombo/subscriptions\",\"organizations_url\":\"https://api.github.com/users/mojombo/orgs\",\"repos_url\":\"https://api.github.com/users/mojombo/repos\",\"received_events_url\":\"https://api.github.com/users/mojombo/received_events\",\"type\":\"User\",\"score\":1,\"following_url\":\"https://api.github.com/users/mojombo/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/mojombo/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/mojombo/starred{/owner}{/repo}\",\"events_url\":\"https://api.github.com/users/mojombo/events{/privacy}\",\"site_admin\":true}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a secret scanning alert", - "scope": "secretScanning", - "id": "getAlert", - "method": "GET", - "url": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/secret-scanning#get-a-secret-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"number\":42,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/42\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations\",\"state\":\"open\",\"secret_type\":\"mailchimp_api_key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 404, - "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List secret scanning alerts for a repository", - "scope": "secretScanning", - "id": "listAlertsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/secret-scanning/alerts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "resolved"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_type", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.2/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "resolution", - "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"number\":2,\"created_at\":\"2020-11-06T18:48:51Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/2\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations\",\"state\":\"resolved\",\"resolution\":\"false_positive\",\"resolved_at\":\"2020-11-07T02:47:13Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"adafruit_io_key\",\"secret_type_display_name\":\"Adafruit IO Key\",\"secret\":\"aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\"push_protection_bypassed_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"push_protection_bypassed\":true,\"push_protection_bypassed_at\":\"2020-11-06T21:48:51Z\"},{\"number\":1,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/repo/secret-scanning/alerts/1\",\"html_url\":\"https://github.com/owner/repo/security/secret-scanning/1\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations\",\"state\":\"open\",\"resolution\":null,\"resolved_at\":null,\"resolved_by\":null,\"secret_type\":\"mailchimp_api_key\",\"secret_type_display_name\":\"Mailchimp API Key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\",\"push_protection_bypassed_by\":null,\"push_protection_bypassed\":false,\"push_protection_bypassed_at\":null}]" - } - ] - }, - { - "code": 404, - "description": "Repository is public or secret scanning is disabled for the repository", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a secret scanning alert", - "scope": "secretScanning", - "id": "updateAlert", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/secret-scanning#update-a-secret-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["open", "resolved"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "resolution", - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "in": "BODY", - "type": "string", - "required": false, - "enum": [ - null, - "false_positive", - "wont_fix", - "revoked", - "used_in_tests" - ], - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"number\":42,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/42\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations\",\"state\":\"resolved\",\"resolution\":\"used_in_tests\",\"resolved_at\":\"2020-11-16T22:42:07Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"mailchimp_api_key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"}" - } - ] - }, - { - "code": 404, - "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found", - "examples": null - }, - { - "code": 422, - "description": "State does not match the resolution", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Add team member (Legacy)", - "scope": "teams", - "id": "addMemberLegacy", - "method": "PUT", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-21", - "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/enterprise-server@3.2/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#add-team-member-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if team synchronization is set up", - "examples": null - }, - { - "code": 422, - "description": "Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add or update team membership for a user", - "scope": "teams", - "id": "addOrUpdateMembershipForUserInOrg", - "method": "PUT", - "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#add-or-update-team-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": "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": "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 that this user should have in the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["member", "maintainer"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" - } - ] - }, - { - "code": 403, - "description": "Forbidden if team synchronization is set up", - "examples": null - }, - { - "code": 422, - "description": "Unprocessable Entity if you attempt to add an organization to a team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add or update team membership for a user (Legacy)", - "scope": "teams", - "id": "addOrUpdateMembershipForUserLegacy", - "method": "PUT", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "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 that this user should have in the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["member", "maintainer"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" - } - ] - }, - { - "code": 403, - "description": "Forbidden if team synchronization is set up", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Unprocessable Entity if you attempt to add an organization to a team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add or update team project permissions", - "scope": "teams", - "id": "addOrUpdateProjectPermissionsInOrg", - "method": "PUT", - "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\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}/projects/{project_id}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#add-or-update-team-project-permissions", - "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": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 403, - "description": "Forbidden if the project is not owned by the organization", - "examples": [ - { - "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://docs.github.com/enterprise-server@3.2/rest/reference/teams#add-or-update-team-project-permissions\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add or update team project permissions (Legacy)", - "scope": "teams", - "id": "addOrUpdateProjectPermissionsLegacy", - "method": "PUT", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Add or update team project permissions](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#add-or-update-team-project-permissions-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 403, - "description": "Forbidden if the project is not owned by the organization", - "examples": [ - { - "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://docs.github.com/enterprise-server@3.2/rest/reference/teams#add-or-update-team-project-permissions\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add or update team repository permissions", - "scope": "teams", - "id": "addOrUpdateRepoPermissionsInOrg", - "method": "PUT", - "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#add-or-update-team-repository-permissions", - "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": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Add or update team repository permissions (Legacy)", - "scope": "teams", - "id": "addOrUpdateRepoPermissionsLegacy", - "method": "PUT", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.2/rest/reference/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/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#add-or-update-team-repository-permissions-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check team permissions for a project", - "scope": "teams", - "id": "checkPermissionsForProjectInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\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}/projects/{project_id}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#check-team-permissions-for-a-project", - "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": "project_id", - "description": "The unique identifier of the project.", - "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": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}" - } - ] - }, - { - "code": 404, - "description": "Not Found if project is not managed by this team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check team permissions for a project (Legacy)", - "scope": "teams", - "id": "checkPermissionsForProjectLegacy", - "method": "GET", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Check team permissions for a project](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#check-team-permissions-for-a-project-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "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": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}" - } - ] - }, - { - "code": 404, - "description": "Not Found if project is not managed by this team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check team permissions for a repository", - "scope": "teams", - "id": "checkPermissionsForRepoInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#check-team-permissions-for-a-repository", - "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": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Alternative response with repository permissions", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"maintain\":false,\"push\":false,\"triage\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"triage\":false,\"push\":false,\"maintain\":false,\"admin\":false},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}" - } - ] - }, - { - "code": 204, - "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header.", - "examples": null - }, - { - "code": 404, - "description": "Not Found if team does not have permission for the repository", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check team permissions for a repository (Legacy)", - "scope": "teams", - "id": "checkPermissionsForRepoLegacy", - "method": "GET", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "deprecationDate": "2020-01-21", - "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**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 [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#check-team-permissions-for-a-repository) endpoint.\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/enterprise-server@3.2/rest/overview/media-types/) via the `Accept` header:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#check-team-permissions-for-a-repository-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Alternative response with extra repository information", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"maintain\":false,\"push\":false,\"triage\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"triage\":false,\"push\":false,\"maintain\":false,\"admin\":false},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}" - } - ] - }, - { - "code": 204, - "description": "Response if repository is managed by this team", - "examples": null - }, - { - "code": 404, - "description": "Not Found if repository is not managed by this team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a team", - "scope": "teams", - "id": "create", - "method": "POST", - "url": "/orgs/{org}/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#create-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": "name", - "description": "The name of the team.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "maintainers", - "description": "List GitHub IDs for organization members who will become team maintainers.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo_names", - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "privacy", - "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["secret", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ldap_dn", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.2/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a discussion comment", - "scope": "teams", - "id": "createDiscussionCommentInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#create-a-discussion-comment", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a discussion comment (Legacy)", - "scope": "teams", - "id": "createDiscussionCommentLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "isDeprecated": true, - "deprecationDate": "2020-01-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 a discussion comment](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#create-a-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a discussion", - "scope": "teams", - "id": "createDiscussionInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#create-a-discussion", - "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": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion post's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a discussion (Legacy)", - "scope": "teams", - "id": "createDiscussionLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions", - "isDeprecated": true, - "deprecationDate": "2020-01-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 a discussion`](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#create-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion post's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a discussion comment", - "scope": "teams", - "id": "deleteDiscussionCommentInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#delete-a-discussion-comment", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a discussion comment (Legacy)", - "scope": "teams", - "id": "deleteDiscussionCommentLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Delete a discussion comment](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#delete-a-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a discussion", - "scope": "teams", - "id": "deleteDiscussionInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#delete-a-discussion", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a discussion (Legacy)", - "scope": "teams", - "id": "deleteDiscussionLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [`Delete a discussion`](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#delete-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a team", - "scope": "teams", - "id": "deleteInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}", - "isDeprecated": false, - "deprecationDate": null, - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#delete-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": "Delete a team (Legacy)", - "scope": "teams", - "id": "deleteLegacy", - "method": "DELETE", - "url": "/teams/{team_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Delete a team](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#delete-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a team by name", - "scope": "teams", - "id": "getByName", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a team using the team's `slug`. GitHub Enterprise Server generates the `slug` from the team `name`.\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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-a-team-by-name", - "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": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a discussion comment", - "scope": "teams", - "id": "getDiscussionCommentInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-a-discussion-comment", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a discussion comment (Legacy)", - "scope": "teams", - "id": "getDiscussionCommentLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Get a discussion comment](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-a-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a discussion", - "scope": "teams", - "id": "getDiscussionInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-a-discussion", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a discussion (Legacy)", - "scope": "teams", - "id": "getDiscussionLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Get a discussion](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a team (Legacy)", - "scope": "teams", - "id": "getLegacy", - "method": "GET", - "url": "/teams/{team_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Get a team by name](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-a-team-by-name) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#get-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "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\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get team member (Legacy)", - "scope": "teams", - "id": "getMemberLegacy", - "method": "GET", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-21", - "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-team-member-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { "code": 204, "description": "if user is a member", "examples": null }, - { - "code": 404, - "description": "if user is not a member", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get team membership for a user", - "scope": "teams", - "id": "getMembershipForUserInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\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}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#create-a-team).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-team-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": "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": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"maintainer\",\"state\":\"active\"}" - } - ] - }, - { - "code": 404, - "description": "if user has no team membership", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get team membership for a user (Legacy)", - "scope": "teams", - "id": "getMembershipForUserLegacy", - "method": "GET", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Get team membership for a user](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#create-a-team).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-team-membership-for-a-user-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"maintainer\",\"state\":\"active\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List teams", - "scope": "teams", - "id": "list", - "method": "GET", - "url": "/orgs/{org}/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all teams in an organization that are visible to the authenticated user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-teams", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List child teams", - "scope": "teams", - "id": "listChildInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the child teams of the team specified by `{team_slug}`.\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}/teams`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-child-teams", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "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": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if child teams exist", - "examples": [ - { - "data": "[{\"id\":2,\"node_id\":\"MDQ6VGVhbTI=\",\"url\":\"https://api.github.com/teams/2\",\"name\":\"Original Roster\",\"slug\":\"original-roster\",\"description\":\"Started it all.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/2/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/2/repos\",\"parent\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"},\"html_url\":\"https://github.com/orgs/rails/teams/core\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List child teams (Legacy)", - "scope": "teams", - "id": "listChildLegacy", - "method": "GET", - "url": "/teams/{team_id}/teams", - "isDeprecated": true, - "deprecationDate": "2020-01-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 child teams`](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-child-teams) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#list-child-teams-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if child teams exist", - "examples": [ - { - "data": "[{\"id\":2,\"node_id\":\"MDQ6VGVhbTI=\",\"url\":\"https://api.github.com/teams/2\",\"name\":\"Original Roster\",\"slug\":\"original-roster\",\"description\":\"Started it all.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/2/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/2/repos\",\"parent\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"},\"html_url\":\"https://github.com/orgs/rails/teams/core\"}]" - } - ] - }, - { "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": "List discussion comments", - "scope": "teams", - "id": "listDiscussionCommentsInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-discussion-comments", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List discussion comments (Legacy)", - "scope": "teams", - "id": "listDiscussionCommentsLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "isDeprecated": true, - "deprecationDate": "2020-01-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 discussion comments](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-discussion-comments) endpoint.\n\nList all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-discussion-comments-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List discussions", - "scope": "teams", - "id": "listDiscussionsInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-discussions", - "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": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pinned", - "description": "Pinned discussions only filter", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List discussions (Legacy)", - "scope": "teams", - "id": "listDiscussionsLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions", - "isDeprecated": true, - "deprecationDate": "2020-01-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 discussions`](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-discussions) endpoint.\n\nList all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-discussions-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List teams for the authenticated user", - "scope": "teams", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/teams", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/enterprise-server@3.2/apps/building-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-teams-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"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\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List team members", - "scope": "teams", - "id": "listMembersInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/members", - "isDeprecated": false, - "deprecationDate": null, - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-team-members", - "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", - "description": "Filters members returned by their role in the team.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["member", "maintainer", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List team members (Legacy)", - "scope": "teams", - "id": "listMembersLegacy", - "method": "GET", - "url": "/teams/{team_id}/members", - "isDeprecated": true, - "deprecationDate": "2020-01-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 team members`](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-team-members-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "Filters members returned by their role in the team.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["member", "maintainer", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List team projects", - "scope": "teams", - "id": "listProjectsInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the organization projects for a team.\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}/projects`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-team-projects", - "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": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List team projects (Legacy)", - "scope": "teams", - "id": "listProjectsLegacy", - "method": "GET", - "url": "/teams/{team_id}/projects", - "isDeprecated": true, - "deprecationDate": "2020-01-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 team projects`](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#list-team-projects-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List team repositories", - "scope": "teams", - "id": "listReposInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists a team's repositories visible to the authenticated user.\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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-team-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": "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": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List team repositories (Legacy)", - "scope": "teams", - "id": "listReposLegacy", - "method": "GET", - "url": "/teams/{team_id}/repos", - "isDeprecated": true, - "deprecationDate": "2020-01-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 team repositories](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-team-repositories) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#list-team-repositories-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove team member (Legacy)", - "scope": "teams", - "id": "removeMemberLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-21", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#remove-team-member-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 404, - "description": "Not Found if team synchronization is setup", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove team membership for a user", - "scope": "teams", - "id": "removeMembershipForUserInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#remove-team-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": "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": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 403, - "description": "Forbidden if team synchronization is set up", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove team membership for a user (Legacy)", - "scope": "teams", - "id": "removeMembershipForUserLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Remove team membership for a user](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#remove-team-membership-for-a-user-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 403, - "description": "if team synchronization is set up", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove a project from a team", - "scope": "teams", - "id": "removeProjectInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\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}/projects/{project_id}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#remove-a-project-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": "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": "project_id", - "description": "The unique identifier of the project.", - "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": "Remove a project from a team (Legacy)", - "scope": "teams", - "id": "removeProjectLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Remove a project from a team](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#remove-a-project-from-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove a repository from a team", - "scope": "teams", - "id": "removeRepoInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\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}/repos/{owner}/{repo}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#remove-a-repository-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": "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": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove a repository from a team (Legacy)", - "scope": "teams", - "id": "removeRepoLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Remove a repository from a team](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#remove-a-repository-from-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Update a discussion comment", - "scope": "teams", - "id": "updateDiscussionCommentInOrg", - "method": "PATCH", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.2/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#update-a-discussion-comment", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like pineapples?\",\"body_html\":\"

Do you like pineapples?

\",\"body_version\":\"e6907b24d9c93cc0c5024a7af5888116\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a discussion comment (Legacy)", - "scope": "teams", - "id": "updateDiscussionCommentLegacy", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Update a discussion comment](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#update-a-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like pineapples?\",\"body_html\":\"

Do you like pineapples?

\",\"body_version\":\"e6907b24d9c93cc0c5024a7af5888116\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a discussion", - "scope": "teams", - "id": "updateDiscussionInOrg", - "method": "PATCH", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#update-a-discussion", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion post's body text.", - "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": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":1,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Welcome to our first team post\",\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a discussion (Legacy)", - "scope": "teams", - "id": "updateDiscussionLegacy", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Update a discussion](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#update-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion post's body text.", - "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": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":1,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Welcome to our first team post\",\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a team", - "scope": "teams", - "id": "updateInOrg", - "method": "PATCH", - "url": "/orgs/{org}/teams/{team_slug}", - "isDeprecated": false, - "deprecationDate": null, - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams#update-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": "name", - "description": "The name of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["secret", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response when the updated information already exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "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": "Update a team (Legacy)", - "scope": "teams", - "id": "updateLegacy", - "method": "PATCH", - "url": "/teams/{team_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Update a team](https://docs.github.com/enterprise-server@3.2/rest/reference/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#update-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "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 team.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["secret", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response when the updated information already exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "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": "Add an email address for the authenticated user", - "scope": "users", - "id": "addEmailForAuthenticated", - "method": "POST", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint is accessible with the `user` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#add-an-email-address-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "emails", - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@octocat.org\",\"primary\":false,\"verified\":false,\"visibility\":\"public\"},{\"email\":\"octocat@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null},{\"email\":\"mona@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": { - "before": { "scope": "users", "id": "addEmailForAuthenticated" }, - "after": { "scope": "users", "id": "addEmailForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Add an email address for the authenticated user", - "scope": "users", - "id": "addEmailForAuthenticatedUser", - "method": "POST", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint is accessible with the `user` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#add-an-email-address-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "emails", - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@octocat.org\",\"primary\":false,\"verified\":false,\"visibility\":\"public\"},{\"email\":\"octocat@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null},{\"email\":\"mona@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check if a user follows another user", - "scope": "users", - "id": "checkFollowingForUser", - "method": "GET", - "url": "/users/{username}/following/{target_user}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#check-if-a-user-follows-another-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_user", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "if the user follows the target user", - "examples": null - }, - { - "code": 404, - "description": "if the user does not follow the target user", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check if a person is followed by the authenticated user", - "scope": "users", - "id": "checkPersonIsFollowedByAuthenticated", - "method": "GET", - "url": "/user/following/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "if the person is followed by the authenticated user", - "examples": null - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "if the person is not followed by the authenticated user", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a GPG key for the authenticated user", - "scope": "users", - "id": "createGpgKeyForAuthenticated", - "method": "POST", - "url": "/user/gpg_keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#create-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "armored_public_key", - "description": "A GPG key in ASCII-armored format.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": { - "before": { "scope": "users", "id": "createGpgKeyForAuthenticated" }, - "after": { "scope": "users", "id": "createGpgKeyForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Create a GPG key for the authenticated user", - "scope": "users", - "id": "createGpgKeyForAuthenticatedUser", - "method": "POST", - "url": "/user/gpg_keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#create-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "armored_public_key", - "description": "A GPG key in ASCII-armored format.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a public SSH key for the authenticated user", - "scope": "users", - "id": "createPublicSshKeyForAuthenticated", - "method": "POST", - "url": "/user/keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "title", - "description": "A descriptive name for the new key.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key", - "description": "The public SSH key to add to your GitHub account.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": { - "before": { - "scope": "users", - "id": "createPublicSshKeyForAuthenticated" - }, - "after": { - "scope": "users", - "id": "createPublicSshKeyForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Create a public SSH key for the authenticated user", - "scope": "users", - "id": "createPublicSshKeyForAuthenticatedUser", - "method": "POST", - "url": "/user/keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "title", - "description": "A descriptive name for the new key.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key", - "description": "The public SSH key to add to your GitHub account.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete an email address for the authenticated user", - "scope": "users", - "id": "deleteEmailForAuthenticated", - "method": "DELETE", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint is accessible with the `user` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-an-email-address-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "emails", - "description": "Email addresses associated with the GitHub user account.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": { - "before": { "scope": "users", "id": "deleteEmailForAuthenticated" }, - "after": { "scope": "users", "id": "deleteEmailForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Delete an email address for the authenticated user", - "scope": "users", - "id": "deleteEmailForAuthenticatedUser", - "method": "DELETE", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint is accessible with the `user` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-an-email-address-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "emails", - "description": "Email addresses associated with the GitHub user account.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a GPG key for the authenticated user", - "scope": "users", - "id": "deleteGpgKeyForAuthenticated", - "method": "DELETE", - "url": "/user/gpg_keys/{gpg_key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gpg_key_id", - "description": "The unique identifier of the GPG key.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": { - "before": { "scope": "users", "id": "deleteGpgKeyForAuthenticated" }, - "after": { "scope": "users", "id": "deleteGpgKeyForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Delete a GPG key for the authenticated user", - "scope": "users", - "id": "deleteGpgKeyForAuthenticatedUser", - "method": "DELETE", - "url": "/user/gpg_keys/{gpg_key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gpg_key_id", - "description": "The unique identifier of the GPG key.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a public SSH key for the authenticated user", - "scope": "users", - "id": "deletePublicSshKeyForAuthenticated", - "method": "DELETE", - "url": "/user/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_id", - "description": "The unique identifier of the key.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { - "scope": "users", - "id": "deletePublicSshKeyForAuthenticated" - }, - "after": { - "scope": "users", - "id": "deletePublicSshKeyForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Delete a public SSH key for the authenticated user", - "scope": "users", - "id": "deletePublicSshKeyForAuthenticatedUser", - "method": "DELETE", - "url": "/user/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_id", - "description": "The unique identifier of the key.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Follow a user", - "scope": "users", - "id": "follow", - "method": "PUT", - "url": "/user/following/{username}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#follow-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the authenticated user", - "scope": "users", - "id": "getAuthenticated", - "method": "GET", - "url": "/user", - "isDeprecated": false, - "deprecationDate": null, - "description": "If the authenticated user is authenticated through basic authentication or OAuth 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"private_gists\":81,\"total_private_repos\":100,\"owned_private_repos\":100,\"disk_usage\":10000,\"collaborators\":8,\"two_factor_authentication\":true,\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"collaborators\":0}}" - }, - { - "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,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a user", - "scope": "users", - "id": "getByUsername", - "method": "GET", - "url": "/users/{username}", - "isDeprecated": false, - "deprecationDate": 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 Enterprise Server plan. The GitHub App must be authenticated as a user. See \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/enterprise-server@3.2/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [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 Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.2/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/enterprise-server@3.2/rest/reference/users#emails)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"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\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"twitter_username\":\"monatheoctocat\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\"}" - }, - { - "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,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"twitter_username\":\"monatheoctocat\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"plan\":{\"name\":\"pro\",\"space\":976562499,\"collaborators\":0,\"private_repos\":9999}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get contextual information for a user", - "scope": "users", - "id": "getContextForUser", - "method": "GET", - "url": "/users/{username}/hovercard", - "isDeprecated": false, - "deprecationDate": 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```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-contextual-information-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "subject_type", - "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["organization", "repository", "issue", "pull_request"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "subject_id", - "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"contexts\":[{\"message\":\"Owns this repository\",\"octicon\":\"repo\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a GPG key for the authenticated user", - "scope": "users", - "id": "getGpgKeyForAuthenticated", - "method": "GET", - "url": "/user/gpg_keys/{gpg_key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gpg_key_id", - "description": "The unique identifier of the GPG key.", - "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\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "getGpgKeyForAuthenticated" }, - "after": { "scope": "users", "id": "getGpgKeyForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Get a GPG key for the authenticated user", - "scope": "users", - "id": "getGpgKeyForAuthenticatedUser", - "method": "GET", - "url": "/user/gpg_keys/{gpg_key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gpg_key_id", - "description": "The unique identifier of the GPG key.", - "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\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a public SSH key for the authenticated user", - "scope": "users", - "id": "getPublicSshKeyForAuthenticated", - "method": "GET", - "url": "/user/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_id", - "description": "The unique identifier of the key.", - "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": "{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "getPublicSshKeyForAuthenticated" }, - "after": { - "scope": "users", - "id": "getPublicSshKeyForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Get a public SSH key for the authenticated user", - "scope": "users", - "id": "getPublicSshKeyForAuthenticatedUser", - "method": "GET", - "url": "/user/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_id", - "description": "The unique identifier of the key.", - "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": "{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List users", - "scope": "users", - "id": "list", - "method": "GET", - "url": "/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-users", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "A user ID. Only return users with an ID greater than this ID.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "List email addresses for the authenticated user", - "scope": "users", - "id": "listEmailsForAuthenticated", - "method": "GET", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-email-addresses-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "listEmailsForAuthenticated" }, - "after": { "scope": "users", "id": "listEmailsForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "List email addresses for the authenticated user", - "scope": "users", - "id": "listEmailsForAuthenticatedUser", - "method": "GET", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-email-addresses-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List the people the authenticated user follows", - "scope": "users", - "id": "listFollowedByAuthenticated", - "method": "GET", - "url": "/user/following", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people who the authenticated user follows.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-the-people-the-authenticated-user-follows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "listFollowedByAuthenticated" }, - "after": { "scope": "users", "id": "listFollowedByAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "List the people the authenticated user follows", - "scope": "users", - "id": "listFollowedByAuthenticatedUser", - "method": "GET", - "url": "/user/following", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people who the authenticated user follows.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-the-people-the-authenticated-user-follows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List followers of the authenticated user", - "scope": "users", - "id": "listFollowersForAuthenticatedUser", - "method": "GET", - "url": "/user/followers", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people following the authenticated user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-followers-of-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List followers of a user", - "scope": "users", - "id": "listFollowersForUser", - "method": "GET", - "url": "/users/{username}/followers", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people following the specified user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-followers-of-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List the people a user follows", - "scope": "users", - "id": "listFollowingForUser", - "method": "GET", - "url": "/users/{username}/following", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people who the specified user follows.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-the-people-a-user-follows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List GPG keys for the authenticated user", - "scope": "users", - "id": "listGpgKeysForAuthenticated", - "method": "GET", - "url": "/user/gpg_keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-gpg-keys-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"string\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "listGpgKeysForAuthenticated" }, - "after": { "scope": "users", "id": "listGpgKeysForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "List GPG keys for the authenticated user", - "scope": "users", - "id": "listGpgKeysForAuthenticatedUser", - "method": "GET", - "url": "/user/gpg_keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-gpg-keys-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"string\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List GPG keys for a user", - "scope": "users", - "id": "listGpgKeysForUser", - "method": "GET", - "url": "/users/{username}/gpg_keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the GPG keys for a user. This information is accessible by anyone.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-gpg-keys-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"string\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public email addresses for the authenticated user", - "scope": "users", - "id": "listPublicEmailsForAuthenticated", - "method": "GET", - "url": "/user/public_emails", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-email-addresses-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "listPublicEmailsForAuthenticated" }, - "after": { - "scope": "users", - "id": "listPublicEmailsForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "List public email addresses for the authenticated user", - "scope": "users", - "id": "listPublicEmailsForAuthenticatedUser", - "method": "GET", - "url": "/user/public_emails", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-email-addresses-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List public keys for a user", - "scope": "users", - "id": "listPublicKeysForUser", - "method": "GET", - "url": "/users/{username}/keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-keys-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "[{\"id\":1,\"key\":\"ssh-rsa AAA...\"}]" }] - } - ], - "renamed": null - }, - { - "name": "List public SSH keys for the authenticated user", - "scope": "users", - "id": "listPublicSshKeysForAuthenticated", - "method": "GET", - "url": "/user/keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false},{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234\",\"id\":3,\"url\":\"https://api.github.com/user/keys/3\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAB\",\"created_at\":\"2020-07-11T21:31:57Z\",\"verified\":false,\"read_only\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "listPublicSshKeysForAuthenticated" }, - "after": { - "scope": "users", - "id": "listPublicSshKeysForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "List public SSH keys for the authenticated user", - "scope": "users", - "id": "listPublicSshKeysForAuthenticatedUser", - "method": "GET", - "url": "/user/keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.2/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false},{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234\",\"id\":3,\"url\":\"https://api.github.com/user/keys/3\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAB\",\"created_at\":\"2020-07-11T21:31:57Z\",\"verified\":false,\"read_only\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unfollow a user", - "scope": "users", - "id": "unfollow", - "method": "DELETE", - "url": "/user/following/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users#unfollow-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update the authenticated user", - "scope": "users", - "id": "updateAuthenticated", - "method": "PATCH", - "url": "/user", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/users/#update-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "The new name of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "email", - "description": "The publicly visible email address of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "blog", - "description": "The new blog URL of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "twitter_username", - "description": "The new Twitter username of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "company", - "description": "The new company of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "location", - "description": "The new location of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hireable", - "description": "The new hiring availability of the user.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "bio", - "description": "The new short biography of the user.", - "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": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"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\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"private_gists\":81,\"total_private_repos\":100,\"owned_private_repos\":100,\"disk_usage\":10000,\"collaborators\":8,\"two_factor_authentication\":true,\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"collaborators\":0}}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - } -] diff --git a/scripts/update-endpoints/generated/ghe33-endpoints.json b/scripts/update-endpoints/generated/ghe33-endpoints.json deleted file mode 100644 index 96928c3c..00000000 --- a/scripts/update-endpoints/generated/ghe33-endpoints.json +++ /dev/null @@ -1,54277 +0,0 @@ -[ - { - "name": "Add selected repository to an organization secret", - "scope": "actions", - "id": "addSelectedRepoToOrgSecret", - "method": "PUT", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#add-selected-repository-to-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "No Content when repository was added to the selected list", - "examples": null - }, - { - "code": 409, - "description": "Conflict when visibility type is not set to selected", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Cancel a workflow run", - "scope": "actions", - "id": "cancelWorkflowRun", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", - "isDeprecated": false, - "deprecationDate": null, - "description": "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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#cancel-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [{ "data": "null" }] - }, - { "code": 409, "description": "Conflict", "examples": null } - ], - "renamed": null - }, - { - "name": "Create or update an environment secret", - "scope": "actions", - "id": "createOrUpdateEnvironmentSecret", - "method": "PUT", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#create-or-update-an-environment-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "encrypted_value", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-an-environment-public-key) endpoint.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "ID of the key you used to encrypt the secret.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response when creating a secret", - "examples": [{ "data": "null" }] - }, - { - "code": 204, - "description": "Response when updating a secret", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create or update an organization secret", - "scope": "actions", - "id": "createOrUpdateOrgSecret", - "method": "PUT", - "url": "/orgs/{org}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#create-or-update-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "encrypted_value", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-an-organization-public-key) endpoint.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "ID of the key you used to encrypt the secret.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["all", "private", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "in": "BODY", - "type": "integer[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response when creating a secret", - "examples": [{ "data": "null" }] - }, - { - "code": 204, - "description": "Response when updating a secret", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create or update a repository secret", - "scope": "actions", - "id": "createOrUpdateRepoSecret", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#create-or-update-a-repository-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "encrypted_value", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-a-repository-public-key) endpoint.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "ID of the key you used to encrypt the secret.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response when creating a secret", - "examples": [{ "data": "null" }] - }, - { - "code": 204, - "description": "Response when updating a secret", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a registration token for an organization", - "scope": "actions", - "id": "createRegistrationTokenForOrg", - "method": "POST", - "url": "/orgs/{org}/actions/runners/registration-token", - "isDeprecated": false, - "deprecationDate": 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.\n\n#### Example 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```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#create-a-registration-token-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": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"LLBF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-22T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a registration token for a repository", - "scope": "actions", - "id": "createRegistrationTokenForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runners/registration-token", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a token that you can pass to the `config` script. The token expires after one hour. You must authenticate\nusing an access token with the `repo` scope to use this endpoint.\n\n#### Example 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/octo-repo-artifacts --token TOKEN\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#create-a-registration-token-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"LLBF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-22T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a remove token for an organization", - "scope": "actions", - "id": "createRemoveTokenForOrg", - "method": "POST", - "url": "/orgs/{org}/actions/runners/remove-token", - "isDeprecated": false, - "deprecationDate": 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.\n\n#### Example 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```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#create-a-remove-token-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": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"AABF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-29T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a remove token for a repository", - "scope": "actions", - "id": "createRemoveTokenForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runners/remove-token", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\n\n#### Example using remove token\n \nTo remove your self-hosted runner from a repository, replace TOKEN with the remove token provided by this endpoint.\n\n```\n./config.sh remove --token TOKEN\n```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#create-a-remove-token-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"AABF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-29T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a workflow dispatch event", - "scope": "actions", - "id": "createWorkflowDispatch", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", - "isDeprecated": false, - "deprecationDate": 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).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#create-a-workflow-dispatch-event", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The git reference for the workflow. The reference can be a branch or tag name.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "inputs", - "description": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "inputs.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an artifact", - "scope": "actions", - "id": "deleteArtifact", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#delete-an-artifact", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "artifact_id", - "description": "The unique identifier of the artifact.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an environment secret", - "scope": "actions", - "id": "deleteEnvironmentSecret", - "method": "DELETE", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#delete-an-environment-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Default response", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an organization secret", - "scope": "actions", - "id": "deleteOrgSecret", - "method": "DELETE", - "url": "/orgs/{org}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": 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 `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#delete-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a repository secret", - "scope": "actions", - "id": "deleteRepoSecret", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": 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 `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#delete-a-repository-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a self-hosted runner from an organization", - "scope": "actions", - "id": "deleteSelfHostedRunnerFromOrg", - "method": "DELETE", - "url": "/orgs/{org}/actions/runners/{runner_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a self-hosted runner from a repository", - "scope": "actions", - "id": "deleteSelfHostedRunnerFromRepo", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "isDeprecated": false, - "deprecationDate": 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`\nscope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a workflow run", - "scope": "actions", - "id": "deleteWorkflowRun", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#delete-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete workflow run logs", - "scope": "actions", - "id": "deleteWorkflowRunLogs", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#delete-workflow-run-logs", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "Disable a selected repository for GitHub Actions in an organization", - "scope": "actions", - "id": "disableSelectedRepositoryGithubActionsOrganization", - "method": "DELETE", - "url": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Disable a workflow", - "scope": "actions", - "id": "disableWorkflow", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#disable-a-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Download an artifact", - "scope": "actions", - "id": "downloadArtifact", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", - "isDeprecated": false, - "deprecationDate": 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`. 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#download-an-artifact", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "artifact_id", - "description": "The unique identifier of the artifact.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "archive_format", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 302, "description": "Response", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Download job logs for a workflow run", - "scope": "actions", - "id": "downloadJobLogsForWorkflowRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#download-job-logs-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. 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": "job_id", - "description": "The unique identifier of the job.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Download workflow run logs", - "scope": "actions", - "id": "downloadWorkflowRunLogs", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#download-workflow-run-logs", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Enable a selected repository for GitHub Actions in an organization", - "scope": "actions", - "id": "enableSelectedRepositoryGithubActionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Enable a workflow", - "scope": "actions", - "id": "enableWorkflow", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#enable-a-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get allowed actions for an organization", - "scope": "actions", - "id": "getAllowedActionsOrganization", - "method": "GET", - "url": "/orgs/{org}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-allowed-actions-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": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get allowed actions for a repository", - "scope": "actions", - "id": "getAllowedActionsRepository", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-allowed-actions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an artifact", - "scope": "actions", - "id": "getArtifact", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-an-artifact", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "artifact_id", - "description": "The unique identifier of the artifact.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-01-21T14:59:22Z\",\"updated_at\":\"2020-01-21T14:59:22Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an environment public key", - "scope": "actions", - "id": "getEnvironmentPublicKey", - "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-an-environment-public-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an environment secret", - "scope": "actions", - "id": "getEnvironmentSecret", - "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-an-environment-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get GitHub Actions permissions for an organization", - "scope": "actions", - "id": "getGithubActionsPermissionsOrganization", - "method": "GET", - "url": "/orgs/{org}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-github-actions-permissions-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"enabled_repositories\":\"all\",\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/organizations/42/actions/permissions/selected-actions\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get GitHub Actions permissions for a repository", - "scope": "actions", - "id": "getGithubActionsPermissionsRepository", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-github-actions-permissions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"enabled\":true,\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/repositories/42/actions/permissions/selected-actions\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a job for a workflow run", - "scope": "actions", - "id": "getJobForWorkflowRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-a-job-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. 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": "job_id", - "description": "The unique identifier of the job.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an organization public key", - "scope": "actions", - "id": "getOrgPublicKey", - "method": "GET", - "url": "/orgs/{org}/actions/secrets/public-key", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-an-organization-public-key", - "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": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an organization secret", - "scope": "actions", - "id": "getOrgSecret", - "method": "GET", - "url": "/orgs/{org}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get pending deployments for a workflow run", - "scope": "actions", - "id": "getPendingDeploymentsForRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-pending-deployments-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"environment\":{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\"},\"wait_timer\":30,\"wait_timer_started_at\":\"2020-11-23T22:00:40Z\",\"current_user_can_approve\":true,\"reviewers\":[{\"type\":\"User\",\"reviewer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}},{\"type\":\"Team\",\"reviewer\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository public key", - "scope": "actions", - "id": "getRepoPublicKey", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets/public-key", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-a-repository-public-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key_id\":\"012345678912345678\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository secret", - "scope": "actions", - "id": "getRepoSecret", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-a-repository-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the review history for a workflow run", - "scope": "actions", - "id": "getReviewsForRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", - "isDeprecated": false, - "deprecationDate": null, - "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-the-review-history-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"state\":\"approved\",\"comment\":\"Ship it!\",\"environments\":[{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\"}],\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a self-hosted runner for an organization", - "scope": "actions", - "id": "getSelfHostedRunnerForOrg", - "method": "GET", - "url": "/orgs/{org}/actions/runners/{runner_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific self-hosted runner configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-a-self-hosted-runner-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a self-hosted runner for a repository", - "scope": "actions", - "id": "getSelfHostedRunnerForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-a-self-hosted-runner-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "runner_id", - "description": "Unique identifier of the self-hosted runner.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a workflow", - "scope": "actions", - "id": "getWorkflow", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-a-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a workflow run", - "scope": "actions", - "id": "getWorkflowRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"main\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"path\":\".github/workflows/build.yml@main\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List artifacts for a repository", - "scope": "actions", - "id": "listArtifactsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-artifacts-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"Test output\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List environment secrets", - "scope": "actions", - "id": "listEnvironmentSecrets", - "method": "GET", - "url": "/repositories/{repository_id}/environments/{environment_name}/secrets", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-environment-secrets", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List jobs for a workflow run", - "scope": "actions", - "id": "listJobsForWorkflowRun", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#parameters).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-jobs-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["latest", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v3\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\",\"labels\":[\"self-hosted\",\"foo\",\"bar\"],\"runner_id\":1,\"runner_name\":\"my runner\",\"runner_group_id\":2,\"runner_group_name\":\"my runner group\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organization secrets", - "scope": "actions", - "id": "listOrgSecrets", - "method": "GET", - "url": "/orgs/{org}/actions/secrets", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-organization-secrets", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":3,\"secrets\":[{\"name\":\"GIST_ID\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"private\"},{\"name\":\"DEPLOY_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"all\"},{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\",\"visibility\":\"selected\",\"selected_repositories_url\":\"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository secrets", - "scope": "actions", - "id": "listRepoSecrets", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-repository-secrets", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository workflows", - "scope": "actions", - "id": "listRepoWorkflows", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-repository-workflows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"},{\"id\":269289,\"node_id\":\"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\"name\":\"Linter\",\"path\":\".github/workflows/linter.yaml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List runner applications for an organization", - "scope": "actions", - "id": "listRunnerApplicationsForOrg", - "method": "GET", - "url": "/orgs/{org}/actions/runners/downloads", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-runner-applications-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw\",\"sha256_checksum\":\"2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip\",\"filename\":\"actions-runner-win-x64-2.277.1.zip\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List runner applications for a repository", - "scope": "actions", - "id": "listRunnerApplicationsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners/downloads", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-runner-applications-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw\",\"sha256_checksum\":\"2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip\",\"filename\":\"actions-runner-win-x64-2.277.1.zip\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.277.1.tar.gz\",\"temp_download_token\":\"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA\",\"sha256_checksum\":\"a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List selected repositories for an organization secret", - "scope": "actions", - "id": "listSelectedReposForOrgSecret", - "method": "GET", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-selected-repositories-for-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List selected repositories enabled for GitHub Actions in an organization", - "scope": "actions", - "id": "listSelectedRepositoriesEnabledGithubActionsOrganization", - "method": "GET", - "url": "/orgs/{org}/actions/permissions/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List self-hosted runners for an organization", - "scope": "actions", - "id": "listSelfHostedRunnersForOrg", - "method": "GET", - "url": "/orgs/{org}/actions/runners", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all self-hosted runners configured in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-self-hosted-runners-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List self-hosted runners for a repository", - "scope": "actions", - "id": "listSelfHostedRunnersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-self-hosted-runners-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"runners\":[{\"id\":23,\"name\":\"linux_runner\",\"os\":\"linux\",\"status\":\"online\",\"busy\":true,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":11,\"name\":\"Linux\",\"type\":\"read-only\"}]},{\"id\":24,\"name\":\"mac_runner\",\"os\":\"macos\",\"status\":\"offline\",\"busy\":false,\"labels\":[{\"id\":5,\"name\":\"self-hosted\",\"type\":\"read-only\"},{\"id\":7,\"name\":\"X64\",\"type\":\"read-only\"},{\"id\":20,\"name\":\"macOS\",\"type\":\"read-only\"},{\"id\":21,\"name\":\"no-gpu\",\"type\":\"custom\"}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List workflow run artifacts", - "scope": "actions", - "id": "listWorkflowRunArtifacts", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-workflow-run-artifacts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"Test output\",\"size_in_bytes\":453,\"url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\"expired\":false,\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-03-21T14:59:22Z\",\"updated_at\":\"2020-02-21T14:59:22Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List workflow runs for a workflow", - "scope": "actions", - "id": "listWorkflowRuns", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-workflow-runs", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "workflow_id", - "description": "The ID of the workflow. You can also pass the workflow file name as a string.", - "in": "PATH", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actor", - "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "completed", - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "in_progress", - "queued", - "requested", - "waiting" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "created", - "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.3/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List workflow runs for a repository", - "scope": "actions", - "id": "listWorkflowRunsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-workflow-runs-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actor", - "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "completed", - "action_required", - "cancelled", - "failure", - "neutral", - "skipped", - "stale", - "success", - "timed_out", - "in_progress", - "queued", - "requested", - "waiting" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "created", - "description": "Returns workflow runs created within the given date-time range. For more information on the syntax, see \"[Understanding the search syntax](https://docs.github.com/enterprise-server@3.3/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "exclude_pull_requests", - "description": "If `true` pull requests are omitted from the response (empty array).", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"name\":\"Build\",\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"check_suite_id\":42,\"check_suite_node_id\":\"MDEwOkNoZWNrU3VpdGU0Mg==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"workflow_id\":159038,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"check_suite_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yaml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Re-run a workflow", - "scope": "actions", - "id": "reRunWorkflow", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", - "isDeprecated": false, - "deprecationDate": null, - "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#re-run-a-workflow", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [{ "data": "null" }] - } - ], - "renamed": null - }, - { - "name": "Remove selected repository from an organization secret", - "scope": "actions", - "id": "removeSelectedRepoFromOrgSecret", - "method": "DELETE", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#remove-selected-repository-from-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response when repository was removed from the selected list", - "examples": null - }, - { - "code": 409, - "description": "Conflict when visibility type not set to selected", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Review pending deployments for a workflow run", - "scope": "actions", - "id": "reviewPendingDeploymentsForRun", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#review-pending-deployments-for-a-workflow-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "run_id", - "description": "The unique identifier of the workflow run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_ids", - "description": "The list of environment ids to approve or reject", - "in": "BODY", - "type": "integer[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Whether to approve or reject deployment to the specified environments.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["approved", "rejected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment", - "description": "A comment to accompany the deployment review", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set allowed actions for an organization", - "scope": "actions", - "id": "setAllowedActionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-allowed-actions-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "github_owned_allowed", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "patterns_allowed", - "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "in": "BODY", - "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": "Set allowed actions for a repository", - "scope": "actions", - "id": "setAllowedActionsRepository", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-allowed-actions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "github_owned_allowed", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "patterns_allowed", - "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "in": "BODY", - "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": "Set GitHub Actions permissions for an organization", - "scope": "actions", - "id": "setGithubActionsPermissionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-github-actions-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 - }, - { - "name": "enabled_repositories", - "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["all", "none", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allowed_actions", - "description": "The permissions policy that controls the actions that are allowed to run.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "local_only", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Set GitHub Actions permissions for a repository", - "scope": "actions", - "id": "setGithubActionsPermissionsRepository", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-github-actions-permissions-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enabled", - "description": "Whether GitHub Actions is enabled on the repository.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allowed_actions", - "description": "The permissions policy that controls the actions that are allowed to run.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "local_only", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Set selected repositories for an organization secret", - "scope": "actions", - "id": "setSelectedReposForOrgSecret", - "method": "PUT", - "url": "/orgs/{org}/actions/secrets/{secret_name}/repositories", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-selected-repositories-for-an-organization-secret", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_name", - "description": "The name of the secret.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.3/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", - "in": "BODY", - "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 selected repositories enabled for GitHub Actions in an organization", - "scope": "actions", - "id": "setSelectedRepositoriesEnabledGithubActionsOrganization", - "method": "PUT", - "url": "/orgs/{org}/actions/permissions/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_repository_ids", - "description": "List of repository IDs to enable for GitHub Actions.", - "in": "BODY", - "type": "integer[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Check if a repository is starred by the authenticated user", - "scope": "activity", - "id": "checkRepoIsStarredByAuthenticatedUser", - "method": "GET", - "url": "/user/starred/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#check-if-a-repository-is-starred-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if this repository is starred by you", - "examples": null - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if this repository is not starred by you", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a repository subscription", - "scope": "activity", - "id": "deleteRepoSubscription", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#set-a-repository-subscription).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#delete-a-repository-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a thread subscription", - "scope": "activity", - "id": "deleteThreadSubscription", - "method": "DELETE", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#delete-a-thread-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "The unique identifier of the pull request thread.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get feeds", - "scope": "activity", - "id": "getFeeds", - "method": "GET", - "url": "/feeds", - "isDeprecated": false, - "deprecationDate": null, - "description": "GitHub Enterprise Server 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 Enterprise Server global public timeline\n* **User**: The public timeline for any user, using [URI template](https://docs.github.com/enterprise-server@3.3/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 Enterprise Server.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#get-feeds", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"timeline_url\":\"https://github.com/timeline\",\"user_url\":\"https://github.com/{user}\",\"current_user_public_url\":\"https://github.com/octocat\",\"current_user_url\":\"https://github.com/octocat.private?token=abc123\",\"current_user_actor_url\":\"https://github.com/octocat.private.actor?token=abc123\",\"current_user_organization_url\":\"\",\"current_user_organization_urls\":[\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"],\"security_advisories_url\":\"https://github.com/security-advisories\",\"_links\":{\"timeline\":{\"href\":\"https://github.com/timeline\",\"type\":\"application/atom+xml\"},\"user\":{\"href\":\"https://github.com/{user}\",\"type\":\"application/atom+xml\"},\"current_user_public\":{\"href\":\"https://github.com/octocat\",\"type\":\"application/atom+xml\"},\"current_user\":{\"href\":\"https://github.com/octocat.private?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_actor\":{\"href\":\"https://github.com/octocat.private.actor?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_organization\":{\"href\":\"\",\"type\":\"\"},\"current_user_organizations\":[{\"href\":\"https://github.com/organizations/github/octocat.private.atom?token=abc123\",\"type\":\"application/atom+xml\"}]}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository subscription", - "scope": "activity", - "id": "getRepoSubscription", - "method": "GET", - "url": "/repos/{owner}/{repo}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#get-a-repository-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if you subscribe to the repository", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if you don't subscribe to the repository", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a thread", - "scope": "activity", - "id": "getThread", - "method": "GET", - "url": "/notifications/threads/{thread_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#get-a-thread", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "The unique identifier of the pull request thread.", - "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\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a thread subscription for the authenticated user", - "scope": "activity", - "id": "getThreadSubscriptionForAuthenticatedUser", - "method": "GET", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "The unique identifier of the pull request thread.", - "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": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List events for the authenticated user", - "scope": "activity", - "id": "listEventsForAuthenticatedUser", - "method": "GET", - "url": "/users/{username}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-events-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084947\",\"type\":\"WatchEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"action\":\"started\"},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":false,\"created_at\":\"2022-06-07T07:50:26Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List notifications for the authenticated user", - "scope": "activity", - "id": "listNotificationsForAuthenticatedUser", - "method": "GET", - "url": "/notifications", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all notifications for the current user, sorted by most recently updated.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "all", - "description": "If `true`, show notifications marked as read.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "participating", - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 50).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List organization events for the authenticated user", - "scope": "activity", - "id": "listOrgEventsForAuthenticatedUser", - "method": "GET", - "url": "/users/{username}/events/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-organization-events-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":false,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22196946742\",\"type\":\"CreateEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"ref\":null,\"ref_type\":\"repository\",\"master_branch\":\"master\",\"description\":null,\"pusher_type\":\"user\"},\"public\":false,\"created_at\":\"2022-06-07T07:50:26Z\",\"org\":{\"id\":9919,\"login\":\"github\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?\"}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public events", - "scope": "activity", - "id": "listPublicEvents", - "method": "GET", - "url": "/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-public-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084947\",\"type\":\"WatchEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"action\":\"started\"},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-07T07:50:26Z\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List public events for a network of repositories", - "scope": "activity", - "id": "listPublicEventsForRepoNetwork", - "method": "GET", - "url": "/networks/{owner}/{repo}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-public-events-for-a-network-of-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22237752260\",\"type\":\"WatchEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/rrubenich\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"action\":\"started\"},\"public\":true,\"created_at\":\"2022-06-08T23:29:25Z\"}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List public events for a user", - "scope": "activity", - "id": "listPublicEventsForUser", - "method": "GET", - "url": "/users/{username}/events/public", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-public-events-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084947\",\"type\":\"WatchEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"action\":\"started\"},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-08T23:29:25Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public organization events", - "scope": "activity", - "id": "listPublicOrgEvents", - "method": "GET", - "url": "/orgs/{org}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-public-organization-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22237752260\",\"type\":\"WatchEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octo-org/octo-repo\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo\"},\"payload\":{\"action\":\"started\"},\"public\":true,\"created_at\":\"2022-06-08T23:29:25Z\"},{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octo-org/octo-repo\",\"url\":\"https://api.github.com/repos/octo-org/oct-repo\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List events received by the authenticated user", - "scope": "activity", - "id": "listReceivedEventsForUser", - "method": "GET", - "url": "/users/{username}/received_events", - "isDeprecated": false, - "deprecationDate": null, - "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-events-received-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22196946742\",\"type\":\"CreateEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"ref\":null,\"ref_type\":\"repository\",\"master_branch\":\"master\",\"description\":null,\"pusher_type\":\"user\"},\"public\":false,\"created_at\":\"2022-06-07T07:50:26Z\",\"org\":{\"id\":9919,\"login\":\"github\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?\"}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public events received by a user", - "scope": "activity", - "id": "listReceivedPublicEventsForUser", - "method": "GET", - "url": "/users/{username}/received_events/public", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-public-events-received-by-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22196946742\",\"type\":\"CreateEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"ref\":null,\"ref_type\":\"repository\",\"master_branch\":\"master\",\"description\":null,\"pusher_type\":\"user\"},\"public\":false,\"created_at\":\"2022-06-07T07:50:26Z\",\"org\":{\"id\":9919,\"login\":\"github\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?\"}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository events", - "scope": "activity", - "id": "listRepoEvents", - "method": "GET", - "url": "/repos/{owner}/{repo}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repository-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"22249084964\",\"type\":\"PushEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"push_id\":10115855396,\"size\":1,\"distinct_size\":1,\"ref\":\"refs/heads/master\",\"head\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"before\":\"883efe034920928c47fe18598c01249d1a9fdabd\",\"commits\":[{\"sha\":\"7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\",\"author\":{\"email\":\"octocat@github.com\",\"name\":\"Monalisa Octocat\"},\"message\":\"commit\",\"distinct\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300\"}]},\"public\":true,\"created_at\":\"2022-06-09T12:47:28Z\"},{\"id\":\"22237752260\",\"type\":\"WatchEvent\",\"actor\":{\"id\":583231,\"login\":\"octocat\",\"display_login\":\"octocat\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\"},\"repo\":{\"id\":1296269,\"name\":\"octocat/Hello-World\",\"url\":\"https://api.github.com/repos/octocat/Hello-World\"},\"payload\":{\"action\":\"started\"},\"public\":true,\"created_at\":\"2022-06-08T23:29:25Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository notifications for the authenticated user", - "scope": "activity", - "id": "listRepoNotificationsForAuthenticatedUser", - "method": "GET", - "url": "/repos/{owner}/{repo}/notifications", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all notifications for the current user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repository-notifications-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "all", - "description": "If `true`, show notifications marked as read.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "participating", - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\",\"subscription_url\":\"https://api.github.com/notifications/threads/1/subscription\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories starred by the authenticated user", - "scope": "activity", - "id": "listReposStarredByAuthenticatedUser", - "method": "GET", - "url": "/user/starred", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repositories-starred-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "sort", - "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" - } - ] - }, - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List repositories starred by a user", - "scope": "activity", - "id": "listReposStarredByUser", - "method": "GET", - "url": "/users/{username}/starred", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repositories-starred-by-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories watched by a user", - "scope": "activity", - "id": "listReposWatchedByUser", - "method": "GET", - "url": "/users/{username}/subscriptions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists repositories a user is watching.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repositories-watched-by-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List stargazers", - "scope": "activity", - "id": "listStargazersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/stargazers", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-stargazers", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - }, - { - "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List repositories watched by the authenticated user", - "scope": "activity", - "id": "listWatchedReposForAuthenticatedUser", - "method": "GET", - "url": "/user/subscriptions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists repositories the authenticated user is watching.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repositories-watched-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List watchers", - "scope": "activity", - "id": "listWatchersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/subscribers", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people watching the specified repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-watchers", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Mark notifications as read", - "scope": "activity", - "id": "markNotificationsAsRead", - "method": "PUT", - "url": "/notifications", - "isDeprecated": false, - "deprecationDate": null, - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#mark-notifications-as-read", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "last_read_at", - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "read", - "description": "Whether the notification has been read.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"message\":\"Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background.\"}" - } - ] - }, - { "code": 205, "description": "Reset Content", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Mark repository notifications as read", - "scope": "activity", - "id": "markRepoNotificationsAsRead", - "method": "PUT", - "url": "/repos/{owner}/{repo}/notifications", - "isDeprecated": false, - "deprecationDate": null, - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#mark-repository-notifications-as-read", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "last_read_at", - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Response", "examples": null }, - { "code": 205, "description": "Reset Content", "examples": null } - ], - "renamed": null - }, - { - "name": "Mark a thread as read", - "scope": "activity", - "id": "markThreadAsRead", - "method": "PATCH", - "url": "/notifications/threads/{thread_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#mark-a-thread-as-read", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "The unique identifier of the pull request thread.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 205, "description": "Reset Content", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Set a repository subscription", - "scope": "activity", - "id": "setRepoSubscription", - "method": "PUT", - "url": "/repos/{owner}/{repo}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#delete-a-repository-subscription) completely.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#set-a-repository-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "subscribed", - "description": "Determines if notifications should be received from this repository.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ignored", - "description": "Determines if all notifications should be blocked from this repository.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set a thread subscription", - "scope": "activity", - "id": "setThreadSubscription", - "method": "PUT", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "deprecationDate": null, - "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/enterprise-server@3.3/rest/reference/activity#delete-a-thread-subscription) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#set-a-thread-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "The unique identifier of the pull request thread.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ignored", - "description": "Whether to block all notifications from a thread.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Star a repository for the authenticated user", - "scope": "activity", - "id": "starRepoForAuthenticatedUser", - "method": "PUT", - "url": "/user/starred/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#star-a-repository-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unstar a repository for the authenticated user", - "scope": "activity", - "id": "unstarRepoForAuthenticatedUser", - "method": "DELETE", - "url": "/user/starred/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/activity#unstar-a-repository-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Add a repository to an app installation", - "scope": "apps", - "id": "addRepoToInstallation", - "method": "PUT", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.3/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#add-a-repository-to-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "apps", "id": "addRepoToInstallation" }, - "after": { - "scope": "apps", - "id": "addRepoToInstallationForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Add a repository to an app installation", - "scope": "apps", - "id": "addRepoToInstallationForAuthenticatedUser", - "method": "PUT", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.3/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#add-a-repository-to-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Check an authorization", - "scope": "apps", - "id": "checkAuthorization", - "method": "GET", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#check-an-authorization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Check a token", - "scope": "apps", - "id": "checkToken", - "method": "POST", - "url": "/applications/{client_id}/token", - "isDeprecated": false, - "deprecationDate": null, - "description": "OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#check-a-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The access_token of the OAuth application.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a content attachment", - "scope": "apps", - "id": "createContentAttachment", - "method": "POST", - "url": "/content_references/{content_reference_id}/attachments", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Deprecated:** use `apps.createContentAttachmentForRepo()` (`POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments`) instead. Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/rest/reference/apps#create-a-content-attachment", - "previews": [{ "name": "corsair" }], - "headers": [], - "parameters": [ - { - "name": "content_reference_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":101,\"title\":\"[A-1234] Error found in core/models.py file'\",\"body\":\"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a content attachment", - "scope": "apps", - "id": "createContentAttachmentForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://docs.github.com/enterprise-server@3.3/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#create-a-content-attachment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.", - "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. Determined from the `repository` `full_name` of the `content_reference` event.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_reference_id", - "description": "The `id` of the `content_reference` event.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body of the attachment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":101,\"title\":\"[A-1234] Error found in core/models.py file'\",\"body\":\"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 415, - "description": "Preview header missing", - "examples": null - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a GitHub App from a manifest", - "scope": "apps", - "id": "createFromManifest", - "method": "POST", - "url": "/app-manifests/{code}/conversions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#create-a-github-app-from-a-manifest", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "code", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDxOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"],\"client_id\":\"Iv1.8a61f9b3a7aba766\",\"client_secret\":\"1726be1638095a19edd134c77bde3aa2ece1e5d8\",\"webhook_secret\":\"e340154128314309424b7c8e90325147d99fdafa\",\"pem\":\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\\n-----END RSA PRIVATE KEY-----\\n\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create an installation access token for an app", - "scope": "apps", - "id": "createInstallationAccessToken", - "method": "POST", - "url": "/app/installations/{installation_id}/access_tokens", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps/#create-an-installation-access-token-for-an-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repositories", - "description": "List of repository names that the token should have access to", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_ids", - "description": "List of repository IDs that the token should have access to", - "in": "BODY", - "type": "integer[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions", - "description": "The permissions granted to the user-to-server access token.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.actions", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.administration", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.checks", - "description": "The level of permission to grant the access token for checks on code.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.contents", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.deployments", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.environments", - "description": "The level of permission to grant the access token for managing repository environments.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.issues", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.metadata", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.packages", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.pages", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.pull_requests", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.repository_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.repository_projects", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.secret_scanning_alerts", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.secrets", - "description": "The level of permission to grant the access token to manage repository secrets.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.security_events", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.single_file", - "description": "The level of permission to grant the access token to manage just a single file.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.statuses", - "description": "The level of permission to grant the access token for commit statuses.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.vulnerability_alerts", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.workflows", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.members", - "description": "The level of permission to grant the access token for organization teams and members.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_administration", - "description": "The level of permission to grant the access token to manage access to an organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_plan", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_projects", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_packages", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_secrets", - "description": "The level of permission to grant the access token to manage organization secrets.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_self_hosted_runners", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_user_blocking", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.team_discussions", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.content_references", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"token\":\"ghs_16C7e42F292c6912E7710c838347Ae178B4a\",\"expires_at\":\"2016-07-11T22:14:10Z\",\"permissions\":{\"issues\":\"write\",\"contents\":\"read\"},\"repository_selection\":\"selected\",\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete an app authorization", - "scope": "apps", - "id": "deleteAuthorization", - "method": "DELETE", - "url": "/applications/{client_id}/grant", - "isDeprecated": false, - "deprecationDate": null, - "description": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#delete-an-app-authorization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The OAuth access token used to authenticate to the GitHub API.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete an installation for the authenticated app", - "scope": "apps", - "id": "deleteInstallation", - "method": "DELETE", - "url": "/app/installations/{installation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app's access to your account's resources, then we recommend the \"[Suspend an app installation](https://docs.github.com/enterprise-server@3.3/rest/reference/apps/#suspend-an-app-installation)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#delete-an-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an app token", - "scope": "apps", - "id": "deleteToken", - "method": "DELETE", - "url": "/applications/{client_id}/token", - "isDeprecated": false, - "deprecationDate": null, - "description": "OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#delete-an-app-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The OAuth access token used to authenticate to the GitHub API.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get the authenticated app", - "scope": "apps", - "id": "getAuthenticated", - "method": "GET", - "url": "/app", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.3/rest/reference/apps#list-installations-for-the-authenticated-app)\" endpoint.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#get-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an app", - "scope": "apps", - "id": "getBySlug", - "method": "GET", - "url": "/apps/{app_slug}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps/#get-an-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "app_slug", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an installation for the authenticated app", - "scope": "apps", - "id": "getInstallation", - "method": "GET", - "url": "/app/installations/{installation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables an authenticated GitHub App to find an installation's information using the installation id.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#get-an-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"selected\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an organization installation for the authenticated app", - "scope": "apps", - "id": "getOrgInstallation", - "method": "GET", - "url": "/orgs/{org}/installation", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/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/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository installation for the authenticated app", - "scope": "apps", - "id": "getRepoInstallation", - "method": "GET", - "url": "/repos/{owner}/{repo}/installation", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/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/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a user installation for the authenticated app", - "scope": "apps", - "id": "getUserInstallation", - "method": "GET", - "url": "/users/{username}/installation", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#get-a-user-installation-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/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/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a webhook configuration for an app", - "scope": "apps", - "id": "getWebhookConfigForApp", - "method": "GET", - "url": "/app/hook/config", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#get-a-webhook-configuration-for-an-app", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a delivery for an app webhook", - "scope": "apps", - "id": "getWebhookDelivery", - "method": "GET", - "url": "/app/hook/deliveries/{delivery_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#get-a-delivery-for-an-app-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "delivery_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"url\":\"https://www.example.com\",\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List repositories accessible to the user access token", - "scope": "apps", - "id": "listInstallationReposForAuthenticatedUser", - "method": "GET", - "url": "/user/installations/{installation_id}/repositories", - "isDeprecated": false, - "deprecationDate": 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-to-server OAuth access token](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#list-repositories-accessible-to-the-user-access-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The access the user has to each repository is included in the hash under the `permissions` key.", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List installations for the authenticated app", - "scope": "apps", - "id": "listInstallations", - "method": "GET", - "url": "/app/installations", - "isDeprecated": false, - "deprecationDate": null, - "description": "You must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#list-installations-for-the-authenticated-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "outdated", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The permissions the installation has are included under the `permissions` key.", - "examples": [ - { - "data": "[{\"id\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"selected\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List app installations accessible to the user access token", - "scope": "apps", - "id": "listInstallationsForAuthenticatedUser", - "method": "GET", - "url": "/user/installations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user-to-server OAuth access token](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "You can find the permissions for the installation under the `permissions` key.", - "examples": [ - { - "data": "{\"total_count\":2,\"installations\":[{\"id\":1,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null},{\"id\":3,\"account\":{\"login\":\"octocat\",\"id\":2,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yaml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"repository_selection\":\"all\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List repositories accessible to the app installation", - "scope": "apps", - "id": "listReposAccessibleToInstallation", - "method": "GET", - "url": "/installation/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "List repositories that an app installation can access.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#list-repositories-accessible-to-the-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List deliveries for an app webhook", - "scope": "apps", - "id": "listWebhookDeliveries", - "method": "GET", - "url": "/app/hook/deliveries", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a list of webhook deliveries for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#list-deliveries-for-an-app-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "cursor", - "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456},{\"id\":123456789,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-04T00:57:16Z\",\"redelivery\":true,\"duration\":0.28,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456}]" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Redeliver a delivery for an app webhook", - "scope": "apps", - "id": "redeliverWebhookDelivery", - "method": "POST", - "url": "/app/hook/deliveries/{delivery_id}/attempts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Redeliver a delivery for the webhook configured for a GitHub App.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#redeliver-a-delivery-for-an-app-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "delivery_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove a repository from an app installation", - "scope": "apps", - "id": "removeRepoFromInstallation", - "method": "DELETE", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.3/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#remove-a-repository-from-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "apps", "id": "removeRepoFromInstallation" }, - "after": { - "scope": "apps", - "id": "removeRepoFromInstallationForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Remove a repository from an app installation", - "scope": "apps", - "id": "removeRepoFromInstallationForAuthenticatedUser", - "method": "DELETE", - "url": "/user/installations/{installation_id}/repositories/{repository_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.3/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#remove-a-repository-from-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_id", - "description": "The unique identifier of the repository.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Reset an authorization", - "scope": "apps", - "id": "resetAuthorization", - "method": "POST", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#reset-an-authorization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Reset a token", - "scope": "apps", - "id": "resetToken", - "method": "PATCH", - "url": "/applications/{client_id}/token", - "isDeprecated": false, - "deprecationDate": null, - "description": "OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#reset-a-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The access_token of the OAuth application.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\",\"user\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Revoke an authorization for an application", - "scope": "apps", - "id": "revokeAuthorizationForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-an-authorization-for-an-application", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "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": "Revoke a grant for an application", - "scope": "apps", - "id": "revokeGrantForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/grants/{access_token}", - "isDeprecated": true, - "deprecationDate": "2020-02-14", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue OAuth endpoints that contain `access_token` in the path parameter. We have introduced new endpoints that allow you to securely manage tokens for OAuth Apps by moving `access_token` to the request body. For more information, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-app-endpoint/).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub Enterprise Server](https://github.com/settings/applications#authorized).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-a-grant-for-an-application", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "", - "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": "Revoke an installation access token", - "scope": "apps", - "id": "revokeInstallationAccessToken", - "method": "DELETE", - "url": "/installation/token", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/apps#create-an-installation-access-token-for-an-app)\" endpoint.\n\nYou must use an [installation access token](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-an-installation-access-token", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Create a scoped access token", - "scope": "apps", - "id": "scopeToken", - "method": "POST", - "url": "/applications/{client_id}/token/scoped", - "isDeprecated": false, - "deprecationDate": null, - "description": "Use a non-scoped user-to-server OAuth access token to create a repository scoped and/or permission scoped user-to-server OAuth access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/enterprise-server@3.3/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#create-a-scoped-access-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "The client ID of the GitHub app.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "The OAuth access token used to authenticate to the GitHub API.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target", - "description": "The name of the user or organization to scope the user-to-server access token to. **Required** unless `target_id` is specified.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_id", - "description": "The ID of the user or organization to scope the user-to-server access token to. **Required** unless `target` is specified.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repositories", - "description": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository_ids", - "description": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", - "in": "BODY", - "type": "integer[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions", - "description": "The permissions granted to the user-to-server access token.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.actions", - "description": "The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.administration", - "description": "The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.checks", - "description": "The level of permission to grant the access token for checks on code.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.contents", - "description": "The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.deployments", - "description": "The level of permission to grant the access token for deployments and deployment statuses.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.environments", - "description": "The level of permission to grant the access token for managing repository environments.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.issues", - "description": "The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.metadata", - "description": "The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.packages", - "description": "The level of permission to grant the access token for packages published to GitHub Packages.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.pages", - "description": "The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.pull_requests", - "description": "The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.repository_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for a repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.repository_projects", - "description": "The level of permission to grant the access token to manage repository projects, columns, and cards.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.secret_scanning_alerts", - "description": "The level of permission to grant the access token to view and manage secret scanning alerts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.secrets", - "description": "The level of permission to grant the access token to manage repository secrets.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.security_events", - "description": "The level of permission to grant the access token to view and manage security events like code scanning alerts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.single_file", - "description": "The level of permission to grant the access token to manage just a single file.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.statuses", - "description": "The level of permission to grant the access token for commit statuses.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.vulnerability_alerts", - "description": "The level of permission to grant the access token to manage Dependabot alerts.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.workflows", - "description": "The level of permission to grant the access token to update GitHub Actions workflow files.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.members", - "description": "The level of permission to grant the access token for organization teams and members.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_administration", - "description": "The level of permission to grant the access token to manage access to an organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_hooks", - "description": "The level of permission to grant the access token to manage the post-receive hooks for an organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_plan", - "description": "The level of permission to grant the access token for viewing an organization's plan.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_projects", - "description": "The level of permission to grant the access token to manage organization projects and projects beta (where available).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_packages", - "description": "The level of permission to grant the access token for organization packages published to GitHub Packages.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_secrets", - "description": "The level of permission to grant the access token to manage organization secrets.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_self_hosted_runners", - "description": "The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.organization_user_blocking", - "description": "The level of permission to grant the access token to view and manage users blocked by the organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.team_discussions", - "description": "The level of permission to grant the access token to manage team discussions and related comments.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions.content_references", - "description": "The level of permission to grant the access token for notification of content references and creation content attachments.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"Iv1.8a61f9b3a7aba766\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"expires_at\":\"2011-09-08T17:26:27Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"installation\":{\"permissions\":{\"metadata\":\"read\",\"issues\":\"write\",\"contents\":\"read\"},\"repository_selection\":\"selected\",\"single_file_name\":\".github/workflow.yml\",\"repositories_url\":\"https://api.github.com/user/repos\",\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"has_multiple_single_files\":false,\"single_file_paths\":[]}}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Suspend an app installation", - "scope": "apps", - "id": "suspendInstallation", - "method": "PUT", - "url": "/app/installations/{installation_id}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "description": "Suspends a GitHub App on a user, organization, or business account, which blocks the app from accessing the account's resources. When a GitHub App is suspended, the app's access to the GitHub Enterprise Server API or webhook events is blocked for that account.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#suspend-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unsuspend an app installation", - "scope": "apps", - "id": "unsuspendInstallation", - "method": "DELETE", - "url": "/app/installations/{installation_id}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes a GitHub App installation suspension.\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#unsuspend-an-app-installation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "installation_id", - "description": "The unique identifier of the installation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a webhook configuration for an app", - "scope": "apps", - "id": "updateWebhookConfigForApp", - "method": "PATCH", - "url": "/app/hook/config", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see \"[Creating a GitHub App](/developers/apps/creating-a-github-app).\"\n\nYou must use a [JWT](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/apps#update-a-webhook-configuration-for-an-app", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a check run", - "scope": "checks", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-runs", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.\n\nIn a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/checks#create-a-check-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": ["queued", "in_progress"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"42\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - }, - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"42\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"in_progress\",\"conclusion\":null,\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":null,\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a check suite", - "scope": "checks", - "id": "createSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.3/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/checks#create-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head_sha", - "description": "The sha of the head commit.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response when the suite already exists", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" - } - ] - }, - { - "code": 201, - "description": "Response when the suite was created", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a check run", - "scope": "checks", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/checks#get-a-check-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_run_id", - "description": "The unique identifier of the check run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a check suite", - "scope": "checks", - "id": "getSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/checks#get-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_suite_id", - "description": "The unique identifier of the check suite.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List check run annotations", - "scope": "checks", - "id": "listAnnotations", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/checks#list-check-run-annotations", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_run_id", - "description": "The unique identifier of the check run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"path\":\"README.md\",\"start_line\":2,\"end_line\":2,\"start_column\":5,\"end_column\":10,\"annotation_level\":\"warning\",\"title\":\"Spell Checker\",\"message\":\"Check your spelling for 'banaas'.\",\"raw_details\":\"Do you mean 'bananas' or 'banana'?\",\"blob_href\":\"https://api.github.com/repos/github/rest-api-description/git/blobs/abc\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List check runs for a Git reference", - "scope": "checks", - "id": "listForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/checks#list-check-runs-for-a-git-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns check runs with the specified `status`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["queued", "in_progress", "completed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["latest", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "app_id", - "description": "", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List check runs in a check suite", - "scope": "checks", - "id": "listForSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/checks#list-check-runs-in-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_suite_id", - "description": "The unique identifier of the check suite.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns check runs with the specified `status`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["queued", "in_progress", "completed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["latest", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List check suites for a Git reference", - "scope": "checks", - "id": "listSuitesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/checks#list-check-suites-for-a-git-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "app_id", - "description": "Filters check suites by GitHub App `id`.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"check_suites\":[{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0},\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"head_commit\":{\"id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"tree_id\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"timestamp\":\"2016-10-10T00:00:00Z\",\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"}},\"latest_check_runs_count\":1,\"check_runs_url\":\"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Rerequest a check run", - "scope": "checks", - "id": "rerequestRun", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.3/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/checks#rerequest-a-check-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_run_id", - "description": "The unique identifier of the check run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 201, "description": "Response", "examples": null }, - { - "code": 403, - "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation error if the check run is not rerequestable", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Rerequest a check suite", - "scope": "checks", - "id": "rerequestSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.3/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/checks#rerequest-a-check-suite", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_suite_id", - "description": "The unique identifier of the check suite.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 201, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Update repository preferences for check suites", - "scope": "checks", - "id": "setSuitesPreferences", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-suites/preferences", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.3/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-repository-preferences-for-check-suites", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_trigger_checks", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#auto_trigger_checks-object) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_trigger_checks[].app_id", - "description": "The `id` of the GitHub App.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_trigger_checks[].setting", - "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"preferences\":{\"auto_trigger_checks\":[{\"app_id\":2,\"setting\":true},{\"app_id\":4,\"setting\":false}]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a check run", - "scope": "checks", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_run_id", - "description": "The unique identifier of the check run.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the check. For example, \"code-coverage\".", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "details_url", - "description": "The URL of the integrator's site that has the full details of the check.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "external_id", - "description": "A reference for the run on the integrator's system.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "started_at", - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "The current status.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["queued", "in_progress", "completed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "conclusion", - "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.", - "in": "BODY", - "type": "string", - "required": false, - "enum": [ - "action_required", - "cancelled", - "failure", - "neutral", - "success", - "skipped", - "stale", - "timed_out" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "completed_at", - "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#output-object-1) description.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.title", - "description": "**Required**.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.summary", - "description": "Can contain Markdown.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.text", - "description": "Can contain Markdown.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].path", - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].start_line", - "description": "The start line of the annotation.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].end_line", - "description": "The end line of the annotation.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].start_column", - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].end_column", - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].annotation_level", - "description": "The level of the annotation.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["notice", "warning", "failure"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].message", - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].title", - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].raw_details", - "description": "Details about this annotation. The maximum size is 64 KB.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.images", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#annotations-object-1) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.images[].alt", - "description": "The alternative text for the image.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.images[].image_url", - "description": "The full URL of the image.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.images[].caption", - "description": "A short image description.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actions", - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://docs.github.com/enterprise-server@3.3/rest/reference/checks#check-runs-and-requested-actions).\"", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actions[].label", - "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actions[].description", - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actions[].identifier", - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"https://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a code scanning analysis from a repository", - "scope": "codeScanning", - "id": "deleteAnalysis", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a specified code scanning analysis from a repository. For\nprivate repositories, you must use an access token with the `repo` scope. For public repositories,\nyou must use an access token with `public_repo` and `repo:security_events` scopes.\nGitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou can delete one analysis at a time.\nTo delete a series of analyses, start with the most recent analysis and work backwards.\nConceptually, the process is similar to the undo function in a text editor.\n\n**Note**: The ability to delete analyses was introduced in GitHub Enterprise Server 3.1.\nYou can delete analyses that were generated prior to installing this release,\nhowever, if you do so, you will lose information about fixed alerts for all such analyses,\nfor the relevant code scanning tool.\nWe recommend that you only delete analyses that were generated with earlier releases\nif you don't need the details of fixed alerts from pre-3.1 releases.\n\nWhen you list the analyses for a repository,\none or more will be identified as deletable in the response:\n\n```\n\"deletable\": true\n```\n\nAn analysis is deletable when it's the most recent in a set of analyses.\nTypically, a repository will have multiple sets of analyses\nfor each enabled code scanning tool,\nwhere a set is determined by a unique combination of analysis values:\n\n* `ref`\n* `tool`\n* `analysis_key`\n* `environment`\n\nIf you attempt to delete an analysis that is not the most recent in a set,\nyou'll get a 400 response with the message:\n\n```\nAnalysis specified is not deletable.\n```\n\nThe response from a successful `DELETE` operation provides you with\ntwo alternative URLs for deleting the next analysis in the set\n(see the example default response below).\nUse the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis\nin the set. This is a useful option if you want to preserve at least one analysis\nfor the specified tool in your repository.\nUse the `confirm_delete_url` URL if you are content to remove all analyses for a tool.\nWhen you delete the last analysis in a set the value of `next_analysis_url` and `confirm_delete_url`\nin the 200 response is `null`.\n\nAs an example of the deletion process,\nlet's imagine that you added a workflow that configured a particular code scanning tool\nto analyze the code in a repository. This tool has added 15 analyses:\n10 on the default branch, and another 5 on a topic branch.\nYou therefore have two separate sets of analyses for this tool.\nYou've now decided that you want to remove all of the analyses for the tool.\nTo do this you must make 15 separate deletion requests.\nTo start, you must find the deletable analysis for one of the sets,\nstep through deleting the analyses in that set,\nand then repeat the process for the second set.\nThe procedure therefore consists of a nested loop:\n\n**Outer loop**:\n* List the analyses for the repository, filtered by tool.\n* Parse this list to find a deletable analysis. If found:\n\n **Inner loop**:\n * Delete the identified analysis.\n * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration.\n\nThe above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "analysis_id", - "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "confirm_delete", - "description": "Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"next_analysis_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41\",\"confirm_delete_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete\"}" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 403, - "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a code scanning alert", - "scope": "codeScanning", - "id": "getAlert", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/code-scanning#get-a-code-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"number\":42,\"created_at\":\"2020-06-19T11:21:34Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/42\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":54933897,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"security_severity_level\":\"high\",\"description\":\"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\"name\":\"js/zipslip\",\"full_description\":\"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"help\":\"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\",\"help_uri\":\"https://codeql.github.com/\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"dismissed\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"}" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a code scanning analysis for a repository", - "scope": "codeScanning", - "id": "getAnalysis", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "analysis_id", - "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/main\",\"commit_sha\":\"c18c69115654ff0166991962832dc2bd7756e655\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:analyze\",\"environment\":\"{\\\"language\\\":\\\"javascript\\\"}\",\"error\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:analyze/language:javascript\",\"created_at\":\"2021-01-13T11:55:49Z\",\"results_count\":3,\"rules_count\":67,\"id\":3602840,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\"sarif_id\":\"47177e22-5596-11eb-80a1-c1e54ef945c6\",\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"deletable\":true,\"warning\":\"\"}" - } - ] - }, - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"runs\":[{\"tool\":{\"driver\":{\"name\":\"CodeQL\",\"organization\":\"GitHub\",\"semanticVersion\":\"1.0.0\",\"rules\":[{\"id\":\"js/unused-local-variable\",\"name\":\"js/unused-local-variable\"}]}},\"results\":[{\"guid\":\"326aa09f-9af8-13cf-9851-3d0e5183ec38\",\"message\":{\"text\":\"Unused variable foo.\"},\"locations\":[{\"physicalLocation\":{\"artifactLocation\":{\"uri\":\"file1.js\"},\"region\":{\"startLine\":1}}}],\"ruleId\":\"js/unused-local-variable\",\"properties\":[{\"github/alertNumber\":2},{\"github/alertUrl\":\"https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2\"}]}]}]}" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get information about a SARIF upload", - "scope": "codeScanning", - "id": "getSarif", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository).\" You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/code-scanning#list-recent-code-scanning-analyses-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sarif_id", - "description": "The SARIF ID obtained after uploading.", - "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": "{\"processing_status\":\"complete\",\"analyses_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6\"}" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { - "code": 404, - "description": "Not Found if the sarif id does not match any upload", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List instances of a code scanning alert", - "scope": "codeScanning", - "id": "listAlertInstances", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"fixed\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List code scanning alerts for a repository", - "scope": "codeScanning", - "id": "listAlertsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_guid", - "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "dismissed", "fixed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"number\":4,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/4\",\"state\":\"open\",\"dismissed_by\":null,\"dismissed_at\":null,\"dismissed_reason\":null,\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances\"},{\"number\":3,\"created_at\":\"2020-02-13T12:29:18Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/3\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-02-14T12:29:18Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"description\":\"Arbitrary file write during zip extraction\",\"name\":\"js/zipslip\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances\"}]" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List instances of a code scanning alert", - "scope": "codeScanning", - "id": "listAlertsInstances", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"state\":\"open\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"lib/ab12-gen.js\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"library\"]},{\"ref\":\"refs/pull/3740/merge\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"state\":\"fixed\",\"commit_sha\":\"b09da05606e27f463a2b49287684b4ae777092f2\",\"message\":{\"text\":\"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"},\"location\":{\"path\":\"app/script.js\",\"start_line\":2,\"end_line\":2,\"start_column\":10,\"end_column\":50},\"classifications\":[\"source\"]}]" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": { - "before": { "scope": "codeScanning", "id": "listAlertsInstances" }, - "after": { "scope": "codeScanning", "id": "listAlertInstances" }, - "date": "2021-04-30", - "note": null - } - }, - { - "name": "List code scanning analyses for a repository", - "scope": "codeScanning", - "id": "listRecentAnalyses", - "method": "GET", - "url": "/repos/{owner}/{repo}/code-scanning/analyses", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_name", - "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_guid", - "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sarif_id", - "description": "Filter analyses belonging to the same SARIF upload.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"ref\":\"refs/heads/main\",\"commit_sha\":\"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:analyze\",\"environment\":\"{\\\"language\\\":\\\"python\\\"}\",\"error\":\"\",\"category\":\".github/workflows/codeql-analysis.yml:analyze/language:python\",\"created_at\":\"2020-08-27T15:05:21Z\",\"results_count\":17,\"rules_count\":49,\"id\":201,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\"sarif_id\":\"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"deletable\":true,\"warning\":\"\"},{\"ref\":\"refs/heads/my-branch\",\"commit_sha\":\"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\"analysis_key\":\".github/workflows/shiftleft.yml:build\",\"environment\":\"{}\",\"error\":\"\",\"category\":\".github/workflows/shiftleft.yml:build/\",\"created_at\":\"2020-08-31T22:46:44Z\",\"results_count\":17,\"rules_count\":32,\"id\":200,\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\"sarif_id\":\"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\"tool\":{\"name\":\"Python Security Analysis\",\"guid\":null,\"version\":\"1.2.0\"},\"deletable\":true,\"warning\":\"\"}]" - } - ] - }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a code scanning alert", - "scope": "codeScanning", - "id": "updateAlert", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/code-scanning#update-a-code-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["open", "dismissed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissed_reason", - "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.", - "in": "BODY", - "type": "string", - "required": false, - "enum": [null, "false positive", "won't fix", "used in tests"], - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"number\":42,\"created_at\":\"2020-08-25T21:28:36Z\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\"html_url\":\"https://github.com/octocat/hello-world/code-scanning/42\",\"state\":\"dismissed\",\"dismissed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"dismissed_at\":\"2020-09-02T22:34:56Z\",\"dismissed_reason\":\"false positive\",\"rule\":{\"id\":\"js/zipslip\",\"severity\":\"error\",\"security_severity_level\":\"high\",\"description\":\"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\"name\":\"js/zipslip\",\"full_description\":\"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\"tags\":[\"security\",\"external/cwe/cwe-022\"],\"help\":\"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\",\"help_uri\":\"https://codeql.github.com/\"},\"tool\":{\"name\":\"CodeQL\",\"guid\":null,\"version\":\"2.4.0\"},\"most_recent_instance\":{\"ref\":\"refs/heads/main\",\"analysis_key\":\".github/workflows/codeql-analysis.yml:CodeQL-Build\",\"environment\":\"{}\",\"state\":\"dismissed\",\"commit_sha\":\"39406e42cb832f683daa691dd652a8dc36ee8930\",\"message\":{\"text\":\"This path depends on a user-provided value.\"},\"location\":{\"path\":\"spec-main/api-session-spec.ts\",\"start_line\":917,\"end_line\":917,\"start_column\":7,\"end_column\":18},\"classifications\":[\"test\"]},\"instances_url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"}" - } - ] - }, - { - "code": 403, - "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Upload an analysis as SARIF data", - "scope": "codeScanning", - "id": "uploadSarif", - "method": "POST", - "url": "/repos/{owner}/{repo}/code-scanning/sarifs", - "isDeprecated": false, - "deprecationDate": null, - "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/code-scanning#upload-a-sarif-file", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit to which the analysis you are uploading relates.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^[0-9a-fA-F]+$", - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The full Git reference, formatted as `refs/heads/`,\n`refs/pull//merge`, or `refs/pull//head`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sarif", - "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/enterprise-server@3.3/code-security/secure-coding/sarif-support-for-code-scanning).\"", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "checkout_uri", - "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "started_at", - "description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tool_name", - "description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"id\":\"47177e22-5596-11eb-80a1-c1e54ef945c6\",\"url\":\"https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6\"}" - } - ] - }, - { - "code": 400, - "description": "Bad Request if the sarif field is invalid", - "examples": null - }, - { - "code": 403, - "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 413, - "description": "Payload Too Large if the sarif field is too large", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all codes of conduct", - "scope": "codesOfConduct", - "id": "getAllCodesOfConduct", - "method": "GET", - "url": "/codes_of_conduct", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/codes-of-conduct#get-all-codes-of-conduct", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"citizen_code_of_conduct\",\"name\":\"Citizen Code of Conduct\",\"url\":\"https://api.github.com/codes_of_conduct/citizen_code_of_conduct\",\"html_url\":\"http://citizencodeofconduct.org/\"},{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"html_url\":\"https://www.contributor-covenant.org/version/2/0/code_of_conduct/\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a code of conduct", - "scope": "codesOfConduct", - "id": "getConductCode", - "method": "GET", - "url": "/codes_of_conduct/{key}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/codes-of-conduct#get-a-code-of-conduct", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\n to any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\",\"html_url\":\"http://contributor-covenant.org/version/1/4/\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the code of conduct for a repository", - "scope": "codesOfConduct", - "id": "getForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/community/code_of_conduct", - "isDeprecated": true, - "deprecationDate": "2021-09-29", - "description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.", - "documentationUrl": "https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository", - "previews": [{ "name": "scarlet-witch" }], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\nto any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\nposting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lindseyb@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\",\"html_url\":\"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get emojis", - "scope": "emojis", - "id": "get", - "method": "GET", - "url": "/emojis", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all the emojis available to use on GitHub Enterprise Server.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/emojis#get-emojis", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"100\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4af.png?v8\",\"1234\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f522.png?v8\",\"+1\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8\",\"-1\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8\",\"1st_place_medal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f947.png?v8\",\"2nd_place_medal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f948.png?v8\",\"3rd_place_medal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f949.png?v8\",\"8ball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b1.png?v8\",\"a\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f170.png?v8\",\"ab\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f18e.png?v8\",\"abacus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ee.png?v8\",\"abc\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f524.png?v8\",\"abcd\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f521.png?v8\",\"accept\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f251.png?v8\",\"accordion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa97.png?v8\",\"adhesive_bandage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa79.png?v8\",\"adult\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1.png?v8\",\"aerial_tramway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a1.png?v8\",\"afghanistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1eb.png?v8\",\"airplane\":\"https://github.githubassets.com/images/icons/emoji/unicode/2708.png?v8\",\"aland_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fd.png?v8\",\"alarm_clock\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f0.png?v8\",\"albania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f1.png?v8\",\"alembic\":\"https://github.githubassets.com/images/icons/emoji/unicode/2697.png?v8\",\"algeria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ff.png?v8\",\"alien\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47d.png?v8\",\"ambulance\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f691.png?v8\",\"american_samoa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f8.png?v8\",\"amphora\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3fa.png?v8\",\"anatomical_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fac0.png?v8\",\"anchor\":\"https://github.githubassets.com/images/icons/emoji/unicode/2693.png?v8\",\"andorra\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e9.png?v8\",\"angel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47c.png?v8\",\"anger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a2.png?v8\",\"angola\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f4.png?v8\",\"angry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f620.png?v8\",\"anguilla\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ee.png?v8\",\"anguished\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f627.png?v8\",\"ant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41c.png?v8\",\"antarctica\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f6.png?v8\",\"antigua_barbuda\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ec.png?v8\",\"apple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34e.png?v8\",\"aquarius\":\"https://github.githubassets.com/images/icons/emoji/unicode/2652.png?v8\",\"argentina\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f7.png?v8\",\"aries\":\"https://github.githubassets.com/images/icons/emoji/unicode/2648.png?v8\",\"armenia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f2.png?v8\",\"arrow_backward\":\"https://github.githubassets.com/images/icons/emoji/unicode/25c0.png?v8\",\"arrow_double_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ec.png?v8\",\"arrow_double_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/23eb.png?v8\",\"arrow_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b07.png?v8\",\"arrow_down_small\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f53d.png?v8\",\"arrow_forward\":\"https://github.githubassets.com/images/icons/emoji/unicode/25b6.png?v8\",\"arrow_heading_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/2935.png?v8\",\"arrow_heading_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/2934.png?v8\",\"arrow_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b05.png?v8\",\"arrow_lower_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/2199.png?v8\",\"arrow_lower_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/2198.png?v8\",\"arrow_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/27a1.png?v8\",\"arrow_right_hook\":\"https://github.githubassets.com/images/icons/emoji/unicode/21aa.png?v8\",\"arrow_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b06.png?v8\",\"arrow_up_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/2195.png?v8\",\"arrow_up_small\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f53c.png?v8\",\"arrow_upper_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/2196.png?v8\",\"arrow_upper_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/2197.png?v8\",\"arrows_clockwise\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f503.png?v8\",\"arrows_counterclockwise\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f504.png?v8\",\"art\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a8.png?v8\",\"articulated_lorry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69b.png?v8\",\"artificial_satellite\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f0.png?v8\",\"artist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a8.png?v8\",\"aruba\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fc.png?v8\",\"ascension_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1e8.png?v8\",\"asterisk\":\"https://github.githubassets.com/images/icons/emoji/unicode/002a-20e3.png?v8\",\"astonished\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f632.png?v8\",\"astronaut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f680.png?v8\",\"athletic_shoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45f.png?v8\",\"atm\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e7.png?v8\",\"atom\":\"https://github.githubassets.com/images/icons/emoji/atom.png?v8\",\"atom_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/269b.png?v8\",\"australia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1fa.png?v8\",\"austria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1f9.png?v8\",\"auto_rickshaw\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6fa.png?v8\",\"avocado\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f951.png?v8\",\"axe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa93.png?v8\",\"azerbaijan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ff.png?v8\",\"b\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f171.png?v8\",\"baby\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f476.png?v8\",\"baby_bottle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37c.png?v8\",\"baby_chick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f424.png?v8\",\"baby_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6bc.png?v8\",\"back\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f519.png?v8\",\"bacon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f953.png?v8\",\"badger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a1.png?v8\",\"badminton\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f8.png?v8\",\"bagel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96f.png?v8\",\"baggage_claim\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c4.png?v8\",\"baguette_bread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f956.png?v8\",\"bahamas\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f8.png?v8\",\"bahrain\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ed.png?v8\",\"balance_scale\":\"https://github.githubassets.com/images/icons/emoji/unicode/2696.png?v8\",\"bald_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b2.png?v8\",\"bald_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b2.png?v8\",\"ballet_shoes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa70.png?v8\",\"balloon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f388.png?v8\",\"ballot_box\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5f3.png?v8\",\"ballot_box_with_check\":\"https://github.githubassets.com/images/icons/emoji/unicode/2611.png?v8\",\"bamboo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38d.png?v8\",\"banana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34c.png?v8\",\"bangbang\":\"https://github.githubassets.com/images/icons/emoji/unicode/203c.png?v8\",\"bangladesh\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e9.png?v8\",\"banjo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa95.png?v8\",\"bank\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e6.png?v8\",\"bar_chart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ca.png?v8\",\"barbados\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e7.png?v8\",\"barber\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f488.png?v8\",\"baseball\":\"https://github.githubassets.com/images/icons/emoji/unicode/26be.png?v8\",\"basecamp\":\"https://github.githubassets.com/images/icons/emoji/basecamp.png?v8\",\"basecampy\":\"https://github.githubassets.com/images/icons/emoji/basecampy.png?v8\",\"basket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fa.png?v8\",\"basketball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c0.png?v8\",\"basketball_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8\",\"basketball_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8\",\"bat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f987.png?v8\",\"bath\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c0.png?v8\",\"bathtub\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c1.png?v8\",\"battery\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50b.png?v8\",\"beach_umbrella\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d6.png?v8\",\"bear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43b.png?v8\",\"bearded_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d4.png?v8\",\"beaver\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ab.png?v8\",\"bed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6cf.png?v8\",\"bee\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8\",\"beer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37a.png?v8\",\"beers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37b.png?v8\",\"beetle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab2.png?v8\",\"beginner\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f530.png?v8\",\"belarus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fe.png?v8\",\"belgium\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ea.png?v8\",\"belize\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ff.png?v8\",\"bell\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f514.png?v8\",\"bell_pepper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad1.png?v8\",\"bellhop_bell\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ce.png?v8\",\"benin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ef.png?v8\",\"bento\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f371.png?v8\",\"bermuda\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f2.png?v8\",\"beverage_box\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c3.png?v8\",\"bhutan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f9.png?v8\",\"bicyclist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b4.png?v8\",\"bike\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b2.png?v8\",\"biking_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2642.png?v8\",\"biking_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b4-2640.png?v8\",\"bikini\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f459.png?v8\",\"billed_cap\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e2.png?v8\",\"biohazard\":\"https://github.githubassets.com/images/icons/emoji/unicode/2623.png?v8\",\"bird\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f426.png?v8\",\"birthday\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f382.png?v8\",\"bison\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ac.png?v8\",\"black_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f408-2b1b.png?v8\",\"black_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/26ab.png?v8\",\"black_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4.png?v8\",\"black_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5a4.png?v8\",\"black_joker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f0cf.png?v8\",\"black_large_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b1b.png?v8\",\"black_medium_small_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25fe.png?v8\",\"black_medium_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25fc.png?v8\",\"black_nib\":\"https://github.githubassets.com/images/icons/emoji/unicode/2712.png?v8\",\"black_small_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25aa.png?v8\",\"black_square_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f532.png?v8\",\"blond_haired_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f471-2642.png?v8\",\"blond_haired_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f471.png?v8\",\"blond_haired_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8\",\"blonde_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f471-2640.png?v8\",\"blossom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33c.png?v8\",\"blowfish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f421.png?v8\",\"blue_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d8.png?v8\",\"blue_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f699.png?v8\",\"blue_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f499.png?v8\",\"blue_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e6.png?v8\",\"blueberries\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad0.png?v8\",\"blush\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60a.png?v8\",\"boar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f417.png?v8\",\"boat\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8\",\"bolivia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f4.png?v8\",\"bomb\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a3.png?v8\",\"bone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b4.png?v8\",\"book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8\",\"bookmark\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f516.png?v8\",\"bookmark_tabs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d1.png?v8\",\"books\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4da.png?v8\",\"boom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8\",\"boomerang\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa83.png?v8\",\"boot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f462.png?v8\",\"bosnia_herzegovina\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1e6.png?v8\",\"botswana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fc.png?v8\",\"bouncing_ball_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9-2642.png?v8\",\"bouncing_ball_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9.png?v8\",\"bouncing_ball_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f9-2640.png?v8\",\"bouquet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f490.png?v8\",\"bouvet_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1fb.png?v8\",\"bow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f647.png?v8\",\"bow_and_arrow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f9.png?v8\",\"bowing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f647-2642.png?v8\",\"bowing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f647-2640.png?v8\",\"bowl_with_spoon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f963.png?v8\",\"bowling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b3.png?v8\",\"bowtie\":\"https://github.githubassets.com/images/icons/emoji/bowtie.png?v8\",\"boxing_glove\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94a.png?v8\",\"boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f466.png?v8\",\"brain\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e0.png?v8\",\"brazil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f7.png?v8\",\"bread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35e.png?v8\",\"breast_feeding\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f931.png?v8\",\"bricks\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f1.png?v8\",\"bride_with_veil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8\",\"bridge_at_night\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f309.png?v8\",\"briefcase\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4bc.png?v8\",\"british_indian_ocean_territory\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f4.png?v8\",\"british_virgin_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ec.png?v8\",\"broccoli\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f966.png?v8\",\"broken_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f494.png?v8\",\"broom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f9.png?v8\",\"brown_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e4.png?v8\",\"brown_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f90e.png?v8\",\"brown_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7eb.png?v8\",\"brunei\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f3.png?v8\",\"bubble_tea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cb.png?v8\",\"bucket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa3.png?v8\",\"bug\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41b.png?v8\",\"building_construction\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d7.png?v8\",\"bulb\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a1.png?v8\",\"bulgaria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ec.png?v8\",\"bullettrain_front\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f685.png?v8\",\"bullettrain_side\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f684.png?v8\",\"burkina_faso\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1eb.png?v8\",\"burrito\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32f.png?v8\",\"burundi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1ee.png?v8\",\"bus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68c.png?v8\",\"business_suit_levitating\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f574.png?v8\",\"busstop\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68f.png?v8\",\"bust_in_silhouette\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f464.png?v8\",\"busts_in_silhouette\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f465.png?v8\",\"butter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c8.png?v8\",\"butterfly\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98b.png?v8\",\"cactus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f335.png?v8\",\"cake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f370.png?v8\",\"calendar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c6.png?v8\",\"call_me_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f919.png?v8\",\"calling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f2.png?v8\",\"cambodia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ed.png?v8\",\"camel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png?v8\",\"camera\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f7.png?v8\",\"camera_flash\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f8.png?v8\",\"cameroon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f2.png?v8\",\"camping\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d5.png?v8\",\"canada\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e6.png?v8\",\"canary_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e8.png?v8\",\"cancer\":\"https://github.githubassets.com/images/icons/emoji/unicode/264b.png?v8\",\"candle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f56f.png?v8\",\"candy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36c.png?v8\",\"canned_food\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96b.png?v8\",\"canoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f6.png?v8\",\"cape_verde\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fb.png?v8\",\"capital_abcd\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f520.png?v8\",\"capricorn\":\"https://github.githubassets.com/images/icons/emoji/unicode/2651.png?v8\",\"car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8\",\"card_file_box\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5c3.png?v8\",\"card_index\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c7.png?v8\",\"card_index_dividers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5c2.png?v8\",\"caribbean_netherlands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f6.png?v8\",\"carousel_horse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a0.png?v8\",\"carpentry_saw\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9a.png?v8\",\"carrot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f955.png?v8\",\"cartwheeling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f938.png?v8\",\"cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f431.png?v8\",\"cat2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f408.png?v8\",\"cayman_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fe.png?v8\",\"cd\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4bf.png?v8\",\"central_african_republic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1eb.png?v8\",\"ceuta_melilla\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e6.png?v8\",\"chad\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e9.png?v8\",\"chains\":\"https://github.githubassets.com/images/icons/emoji/unicode/26d3.png?v8\",\"chair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa91.png?v8\",\"champagne\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37e.png?v8\",\"chart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b9.png?v8\",\"chart_with_downwards_trend\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c9.png?v8\",\"chart_with_upwards_trend\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c8.png?v8\",\"checkered_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png?v8\",\"cheese\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c0.png?v8\",\"cherries\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f352.png?v8\",\"cherry_blossom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f338.png?v8\",\"chess_pawn\":\"https://github.githubassets.com/images/icons/emoji/unicode/265f.png?v8\",\"chestnut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f330.png?v8\",\"chicken\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f414.png?v8\",\"child\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d2.png?v8\",\"children_crossing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b8.png?v8\",\"chile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f1.png?v8\",\"chipmunk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43f.png?v8\",\"chocolate_bar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36b.png?v8\",\"chopsticks\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f962.png?v8\",\"christmas_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fd.png?v8\",\"christmas_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f384.png?v8\",\"church\":\"https://github.githubassets.com/images/icons/emoji/unicode/26ea.png?v8\",\"cinema\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a6.png?v8\",\"circus_tent\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3aa.png?v8\",\"city_sunrise\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f307.png?v8\",\"city_sunset\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f306.png?v8\",\"cityscape\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d9.png?v8\",\"cl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f191.png?v8\",\"clamp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5dc.png?v8\",\"clap\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44f.png?v8\",\"clapper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ac.png?v8\",\"classical_building\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3db.png?v8\",\"climbing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d7.png?v8\",\"climbing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2642.png?v8\",\"climbing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d7-2640.png?v8\",\"clinking_glasses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f942.png?v8\",\"clipboard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4cb.png?v8\",\"clipperton_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f5.png?v8\",\"clock1\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f550.png?v8\",\"clock10\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f559.png?v8\",\"clock1030\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f565.png?v8\",\"clock11\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55a.png?v8\",\"clock1130\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f566.png?v8\",\"clock12\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55b.png?v8\",\"clock1230\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f567.png?v8\",\"clock130\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55c.png?v8\",\"clock2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f551.png?v8\",\"clock230\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55d.png?v8\",\"clock3\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f552.png?v8\",\"clock330\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55e.png?v8\",\"clock4\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f553.png?v8\",\"clock430\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f55f.png?v8\",\"clock5\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f554.png?v8\",\"clock530\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f560.png?v8\",\"clock6\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f555.png?v8\",\"clock630\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f561.png?v8\",\"clock7\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f556.png?v8\",\"clock730\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f562.png?v8\",\"clock8\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f557.png?v8\",\"clock830\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f563.png?v8\",\"clock9\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f558.png?v8\",\"clock930\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f564.png?v8\",\"closed_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d5.png?v8\",\"closed_lock_with_key\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f510.png?v8\",\"closed_umbrella\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f302.png?v8\",\"cloud\":\"https://github.githubassets.com/images/icons/emoji/unicode/2601.png?v8\",\"cloud_with_lightning\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f329.png?v8\",\"cloud_with_lightning_and_rain\":\"https://github.githubassets.com/images/icons/emoji/unicode/26c8.png?v8\",\"cloud_with_rain\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f327.png?v8\",\"cloud_with_snow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f328.png?v8\",\"clown_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f921.png?v8\",\"clubs\":\"https://github.githubassets.com/images/icons/emoji/unicode/2663.png?v8\",\"cn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8\",\"coat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e5.png?v8\",\"cockroach\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab3.png?v8\",\"cocktail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f378.png?v8\",\"coconut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f965.png?v8\",\"cocos_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e8.png?v8\",\"coffee\":\"https://github.githubassets.com/images/icons/emoji/unicode/2615.png?v8\",\"coffin\":\"https://github.githubassets.com/images/icons/emoji/unicode/26b0.png?v8\",\"coin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa99.png?v8\",\"cold_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f976.png?v8\",\"cold_sweat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f630.png?v8\",\"collision\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a5.png?v8\",\"colombia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f4.png?v8\",\"comet\":\"https://github.githubassets.com/images/icons/emoji/unicode/2604.png?v8\",\"comoros\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f2.png?v8\",\"compass\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ed.png?v8\",\"computer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4bb.png?v8\",\"computer_mouse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5b1.png?v8\",\"confetti_ball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38a.png?v8\",\"confounded\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f616.png?v8\",\"confused\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f615.png?v8\",\"congo_brazzaville\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ec.png?v8\",\"congo_kinshasa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1e9.png?v8\",\"congratulations\":\"https://github.githubassets.com/images/icons/emoji/unicode/3297.png?v8\",\"construction\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a7.png?v8\",\"construction_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f477.png?v8\",\"construction_worker_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f477-2642.png?v8\",\"construction_worker_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f477-2640.png?v8\",\"control_knobs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f39b.png?v8\",\"convenience_store\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ea.png?v8\",\"cook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f373.png?v8\",\"cook_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f0.png?v8\",\"cookie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36a.png?v8\",\"cool\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f192.png?v8\",\"cop\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8\",\"copyright\":\"https://github.githubassets.com/images/icons/emoji/unicode/00a9.png?v8\",\"corn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33d.png?v8\",\"costa_rica\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f7.png?v8\",\"cote_divoire\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ee.png?v8\",\"couch_and_lamp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6cb.png?v8\",\"couple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46b.png?v8\",\"couple_with_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f491.png?v8\",\"couple_with_heart_man_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f468.png?v8\",\"couple_with_heart_woman_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f468.png?v8\",\"couple_with_heart_woman_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f469.png?v8\",\"couplekiss\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48f.png?v8\",\"couplekiss_man_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2764-1f48b-1f468.png?v8\",\"couplekiss_man_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f468.png?v8\",\"couplekiss_woman_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2764-1f48b-1f469.png?v8\",\"cow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42e.png?v8\",\"cow2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f404.png?v8\",\"cowboy_hat_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f920.png?v8\",\"crab\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f980.png?v8\",\"crayon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f58d.png?v8\",\"credit_card\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b3.png?v8\",\"crescent_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f319.png?v8\",\"cricket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f997.png?v8\",\"cricket_game\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cf.png?v8\",\"croatia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f7.png?v8\",\"crocodile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40a.png?v8\",\"croissant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f950.png?v8\",\"crossed_fingers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91e.png?v8\",\"crossed_flags\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38c.png?v8\",\"crossed_swords\":\"https://github.githubassets.com/images/icons/emoji/unicode/2694.png?v8\",\"crown\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f451.png?v8\",\"cry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f622.png?v8\",\"crying_cat_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63f.png?v8\",\"crystal_ball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52e.png?v8\",\"cuba\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fa.png?v8\",\"cucumber\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f952.png?v8\",\"cup_with_straw\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f964.png?v8\",\"cupcake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c1.png?v8\",\"cupid\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f498.png?v8\",\"curacao\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fc.png?v8\",\"curling_stone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94c.png?v8\",\"curly_haired_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b1.png?v8\",\"curly_haired_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b1.png?v8\",\"curly_loop\":\"https://github.githubassets.com/images/icons/emoji/unicode/27b0.png?v8\",\"currency_exchange\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b1.png?v8\",\"curry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35b.png?v8\",\"cursing_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92c.png?v8\",\"custard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36e.png?v8\",\"customs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c3.png?v8\",\"cut_of_meat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f969.png?v8\",\"cyclone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f300.png?v8\",\"cyprus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1fe.png?v8\",\"czech_republic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ff.png?v8\",\"dagger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5e1.png?v8\",\"dancer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8\",\"dancers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46f.png?v8\",\"dancing_men\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2642.png?v8\",\"dancing_women\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46f-2640.png?v8\",\"dango\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f361.png?v8\",\"dark_sunglasses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f576.png?v8\",\"dart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3af.png?v8\",\"dash\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a8.png?v8\",\"date\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c5.png?v8\",\"de\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8\",\"deaf_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2642.png?v8\",\"deaf_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cf.png?v8\",\"deaf_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cf-2640.png?v8\",\"deciduous_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f333.png?v8\",\"deer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98c.png?v8\",\"denmark\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f0.png?v8\",\"department_store\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ec.png?v8\",\"derelict_house\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3da.png?v8\",\"desert\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3dc.png?v8\",\"desert_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3dd.png?v8\",\"desktop_computer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5a5.png?v8\",\"detective\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f575.png?v8\",\"diamond_shape_with_a_dot_inside\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a0.png?v8\",\"diamonds\":\"https://github.githubassets.com/images/icons/emoji/unicode/2666.png?v8\",\"diego_garcia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ec.png?v8\",\"disappointed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61e.png?v8\",\"disappointed_relieved\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f625.png?v8\",\"disguised_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f978.png?v8\",\"diving_mask\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93f.png?v8\",\"diya_lamp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa94.png?v8\",\"dizzy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ab.png?v8\",\"dizzy_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f635.png?v8\",\"djibouti\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ef.png?v8\",\"dna\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ec.png?v8\",\"do_not_litter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6af.png?v8\",\"dodo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a4.png?v8\",\"dog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f436.png?v8\",\"dog2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f415.png?v8\",\"dollar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b5.png?v8\",\"dolls\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38e.png?v8\",\"dolphin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8\",\"dominica\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f2.png?v8\",\"dominican_republic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1f4.png?v8\",\"door\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6aa.png?v8\",\"doughnut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f369.png?v8\",\"dove\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f54a.png?v8\",\"dragon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f409.png?v8\",\"dragon_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f432.png?v8\",\"dress\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f457.png?v8\",\"dromedary_camel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42a.png?v8\",\"drooling_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f924.png?v8\",\"drop_of_blood\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa78.png?v8\",\"droplet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a7.png?v8\",\"drum\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f941.png?v8\",\"duck\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f986.png?v8\",\"dumpling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95f.png?v8\",\"dvd\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c0.png?v8\",\"e-mail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8\",\"eagle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f985.png?v8\",\"ear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f442.png?v8\",\"ear_of_rice\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33e.png?v8\",\"ear_with_hearing_aid\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9bb.png?v8\",\"earth_africa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30d.png?v8\",\"earth_americas\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30e.png?v8\",\"earth_asia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30f.png?v8\",\"ecuador\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1e8.png?v8\",\"egg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95a.png?v8\",\"eggplant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f346.png?v8\",\"egypt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ec.png?v8\",\"eight\":\"https://github.githubassets.com/images/icons/emoji/unicode/0038-20e3.png?v8\",\"eight_pointed_black_star\":\"https://github.githubassets.com/images/icons/emoji/unicode/2734.png?v8\",\"eight_spoked_asterisk\":\"https://github.githubassets.com/images/icons/emoji/unicode/2733.png?v8\",\"eject_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23cf.png?v8\",\"el_salvador\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fb.png?v8\",\"electric_plug\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50c.png?v8\",\"electron\":\"https://github.githubassets.com/images/icons/emoji/electron.png?v8\",\"elephant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f418.png?v8\",\"elevator\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d7.png?v8\",\"elf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dd.png?v8\",\"elf_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2642.png?v8\",\"elf_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dd-2640.png?v8\",\"email\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e7.png?v8\",\"end\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51a.png?v8\",\"england\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0065-e006e-e0067-e007f.png?v8\",\"envelope\":\"https://github.githubassets.com/images/icons/emoji/unicode/2709.png?v8\",\"envelope_with_arrow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e9.png?v8\",\"equatorial_guinea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f6.png?v8\",\"eritrea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f7.png?v8\",\"es\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8\",\"estonia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ea.png?v8\",\"ethiopia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f9.png?v8\",\"eu\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8\",\"euro\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b6.png?v8\",\"european_castle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f0.png?v8\",\"european_post_office\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e4.png?v8\",\"european_union\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1fa.png?v8\",\"evergreen_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f332.png?v8\",\"exclamation\":\"https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8\",\"exploding_head\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92f.png?v8\",\"expressionless\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f611.png?v8\",\"eye\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f441.png?v8\",\"eye_speech_bubble\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f441-1f5e8.png?v8\",\"eyeglasses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f453.png?v8\",\"eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f440.png?v8\",\"face_exhaling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62e-1f4a8.png?v8\",\"face_in_clouds\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f636-1f32b.png?v8\",\"face_with_head_bandage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f915.png?v8\",\"face_with_spiral_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f635-1f4ab.png?v8\",\"face_with_thermometer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f912.png?v8\",\"facepalm\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f926.png?v8\",\"facepunch\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8\",\"factory\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ed.png?v8\",\"factory_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3ed.png?v8\",\"fairy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9da.png?v8\",\"fairy_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2642.png?v8\",\"fairy_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9da-2640.png?v8\",\"falafel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c6.png?v8\",\"falkland_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f0.png?v8\",\"fallen_leaf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f342.png?v8\",\"family\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46a.png?v8\",\"family_man_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466.png?v8\",\"family_man_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f466-1f466.png?v8\",\"family_man_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467.png?v8\",\"family_man_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f466.png?v8\",\"family_man_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f467-1f467.png?v8\",\"family_man_man_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466.png?v8\",\"family_man_man_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f466-1f466.png?v8\",\"family_man_man_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467.png?v8\",\"family_man_man_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f466.png?v8\",\"family_man_man_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f468-1f467-1f467.png?v8\",\"family_man_woman_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466.png?v8\",\"family_man_woman_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f466-1f466.png?v8\",\"family_man_woman_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467.png?v8\",\"family_man_woman_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f466.png?v8\",\"family_man_woman_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f469-1f467-1f467.png?v8\",\"family_woman_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466.png?v8\",\"family_woman_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f466-1f466.png?v8\",\"family_woman_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467.png?v8\",\"family_woman_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f466.png?v8\",\"family_woman_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f467-1f467.png?v8\",\"family_woman_woman_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466.png?v8\",\"family_woman_woman_boy_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f466-1f466.png?v8\",\"family_woman_woman_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467.png?v8\",\"family_woman_woman_girl_boy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f466.png?v8\",\"family_woman_woman_girl_girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f469-1f467-1f467.png?v8\",\"farmer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f33e.png?v8\",\"faroe_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f4.png?v8\",\"fast_forward\":\"https://github.githubassets.com/images/icons/emoji/unicode/23e9.png?v8\",\"fax\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e0.png?v8\",\"fearful\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f628.png?v8\",\"feather\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab6.png?v8\",\"feelsgood\":\"https://github.githubassets.com/images/icons/emoji/feelsgood.png?v8\",\"feet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8\",\"female_detective\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f575-2640.png?v8\",\"female_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2640.png?v8\",\"ferris_wheel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a1.png?v8\",\"ferry\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f4.png?v8\",\"field_hockey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d1.png?v8\",\"fiji\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ef.png?v8\",\"file_cabinet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5c4.png?v8\",\"file_folder\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c1.png?v8\",\"film_projector\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4fd.png?v8\",\"film_strip\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f39e.png?v8\",\"finland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1ee.png?v8\",\"finnadie\":\"https://github.githubassets.com/images/icons/emoji/finnadie.png?v8\",\"fire\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f525.png?v8\",\"fire_engine\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f692.png?v8\",\"fire_extinguisher\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ef.png?v8\",\"firecracker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e8.png?v8\",\"firefighter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f692.png?v8\",\"fireworks\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f386.png?v8\",\"first_quarter_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f313.png?v8\",\"first_quarter_moon_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31b.png?v8\",\"fish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41f.png?v8\",\"fish_cake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f365.png?v8\",\"fishing_pole_and_fish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a3.png?v8\",\"fist\":\"https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8\",\"fist_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91b.png?v8\",\"fist_oncoming\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8\",\"fist_raised\":\"https://github.githubassets.com/images/icons/emoji/unicode/270a.png?v8\",\"fist_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91c.png?v8\",\"five\":\"https://github.githubassets.com/images/icons/emoji/unicode/0035-20e3.png?v8\",\"flags\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38f.png?v8\",\"flamingo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a9.png?v8\",\"flashlight\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f526.png?v8\",\"flat_shoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97f.png?v8\",\"flatbread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad3.png?v8\",\"fleur_de_lis\":\"https://github.githubassets.com/images/icons/emoji/unicode/269c.png?v8\",\"flight_arrival\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ec.png?v8\",\"flight_departure\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6eb.png?v8\",\"flipper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42c.png?v8\",\"floppy_disk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4be.png?v8\",\"flower_playing_cards\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b4.png?v8\",\"flushed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f633.png?v8\",\"fly\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab0.png?v8\",\"flying_disc\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94f.png?v8\",\"flying_saucer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f8.png?v8\",\"fog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32b.png?v8\",\"foggy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f301.png?v8\",\"fondue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad5.png?v8\",\"foot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b6.png?v8\",\"football\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c8.png?v8\",\"footprints\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f463.png?v8\",\"fork_and_knife\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f374.png?v8\",\"fortune_cookie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f960.png?v8\",\"fountain\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f2.png?v8\",\"fountain_pen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f58b.png?v8\",\"four\":\"https://github.githubassets.com/images/icons/emoji/unicode/0034-20e3.png?v8\",\"four_leaf_clover\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f340.png?v8\",\"fox_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98a.png?v8\",\"fr\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f7.png?v8\",\"framed_picture\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5bc.png?v8\",\"free\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f193.png?v8\",\"french_guiana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1eb.png?v8\",\"french_polynesia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1eb.png?v8\",\"french_southern_territories\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1eb.png?v8\",\"fried_egg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f373.png?v8\",\"fried_shrimp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f364.png?v8\",\"fries\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35f.png?v8\",\"frog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f438.png?v8\",\"frowning\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f626.png?v8\",\"frowning_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/2639.png?v8\",\"frowning_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2642.png?v8\",\"frowning_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64d.png?v8\",\"frowning_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64d-2640.png?v8\",\"fu\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8\",\"fuelpump\":\"https://github.githubassets.com/images/icons/emoji/unicode/26fd.png?v8\",\"full_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f315.png?v8\",\"full_moon_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31d.png?v8\",\"funeral_urn\":\"https://github.githubassets.com/images/icons/emoji/unicode/26b1.png?v8\",\"gabon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e6.png?v8\",\"gambia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f2.png?v8\",\"game_die\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b2.png?v8\",\"garlic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c4.png?v8\",\"gb\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8\",\"gear\":\"https://github.githubassets.com/images/icons/emoji/unicode/2699.png?v8\",\"gem\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48e.png?v8\",\"gemini\":\"https://github.githubassets.com/images/icons/emoji/unicode/264a.png?v8\",\"genie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9de.png?v8\",\"genie_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2642.png?v8\",\"genie_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9de-2640.png?v8\",\"georgia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ea.png?v8\",\"ghana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ed.png?v8\",\"ghost\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47b.png?v8\",\"gibraltar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ee.png?v8\",\"gift\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f381.png?v8\",\"gift_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49d.png?v8\",\"giraffe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f992.png?v8\",\"girl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f467.png?v8\",\"globe_with_meridians\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f310.png?v8\",\"gloves\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e4.png?v8\",\"goal_net\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f945.png?v8\",\"goat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f410.png?v8\",\"goberserk\":\"https://github.githubassets.com/images/icons/emoji/goberserk.png?v8\",\"godmode\":\"https://github.githubassets.com/images/icons/emoji/godmode.png?v8\",\"goggles\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97d.png?v8\",\"golf\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f3.png?v8\",\"golfing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cc.png?v8\",\"golfing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2642.png?v8\",\"golfing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cc-2640.png?v8\",\"gorilla\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98d.png?v8\",\"grapes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f347.png?v8\",\"greece\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f7.png?v8\",\"green_apple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34f.png?v8\",\"green_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d7.png?v8\",\"green_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e2.png?v8\",\"green_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49a.png?v8\",\"green_salad\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f957.png?v8\",\"green_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e9.png?v8\",\"greenland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f1.png?v8\",\"grenada\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e9.png?v8\",\"grey_exclamation\":\"https://github.githubassets.com/images/icons/emoji/unicode/2755.png?v8\",\"grey_question\":\"https://github.githubassets.com/images/icons/emoji/unicode/2754.png?v8\",\"grimacing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62c.png?v8\",\"grin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f601.png?v8\",\"grinning\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f600.png?v8\",\"guadeloupe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f5.png?v8\",\"guam\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fa.png?v8\",\"guard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f482.png?v8\",\"guardsman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f482-2642.png?v8\",\"guardswoman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f482-2640.png?v8\",\"guatemala\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f9.png?v8\",\"guernsey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1ec.png?v8\",\"guide_dog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ae.png?v8\",\"guinea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f3.png?v8\",\"guinea_bissau\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fc.png?v8\",\"guitar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b8.png?v8\",\"gun\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52b.png?v8\",\"guyana\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1fe.png?v8\",\"haircut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f487.png?v8\",\"haircut_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f487-2642.png?v8\",\"haircut_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f487-2640.png?v8\",\"haiti\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f9.png?v8\",\"hamburger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f354.png?v8\",\"hammer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f528.png?v8\",\"hammer_and_pick\":\"https://github.githubassets.com/images/icons/emoji/unicode/2692.png?v8\",\"hammer_and_wrench\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e0.png?v8\",\"hamster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f439.png?v8\",\"hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8\",\"hand_over_mouth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92d.png?v8\",\"handbag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45c.png?v8\",\"handball_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93e.png?v8\",\"handshake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91d.png?v8\",\"hankey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8\",\"hash\":\"https://github.githubassets.com/images/icons/emoji/unicode/0023-20e3.png?v8\",\"hatched_chick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f425.png?v8\",\"hatching_chick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f423.png?v8\",\"headphones\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a7.png?v8\",\"headstone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa6.png?v8\",\"health_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2695.png?v8\",\"hear_no_evil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f649.png?v8\",\"heard_mcdonald_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f2.png?v8\",\"heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/2764.png?v8\",\"heart_decoration\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49f.png?v8\",\"heart_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60d.png?v8\",\"heart_eyes_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63b.png?v8\",\"heart_on_fire\":\"https://github.githubassets.com/images/icons/emoji/unicode/2764-1f525.png?v8\",\"heartbeat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f493.png?v8\",\"heartpulse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f497.png?v8\",\"hearts\":\"https://github.githubassets.com/images/icons/emoji/unicode/2665.png?v8\",\"heavy_check_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/2714.png?v8\",\"heavy_division_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2797.png?v8\",\"heavy_dollar_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b2.png?v8\",\"heavy_exclamation_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/2757.png?v8\",\"heavy_heart_exclamation\":\"https://github.githubassets.com/images/icons/emoji/unicode/2763.png?v8\",\"heavy_minus_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2796.png?v8\",\"heavy_multiplication_x\":\"https://github.githubassets.com/images/icons/emoji/unicode/2716.png?v8\",\"heavy_plus_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2795.png?v8\",\"hedgehog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f994.png?v8\",\"helicopter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f681.png?v8\",\"herb\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33f.png?v8\",\"hibiscus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33a.png?v8\",\"high_brightness\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f506.png?v8\",\"high_heel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f460.png?v8\",\"hiking_boot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97e.png?v8\",\"hindu_temple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d5.png?v8\",\"hippopotamus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99b.png?v8\",\"hocho\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8\",\"hole\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f573.png?v8\",\"honduras\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f3.png?v8\",\"honey_pot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36f.png?v8\",\"honeybee\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41d.png?v8\",\"hong_kong\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1f0.png?v8\",\"hook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9d.png?v8\",\"horse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f434.png?v8\",\"horse_racing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c7.png?v8\",\"hospital\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e5.png?v8\",\"hot_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f975.png?v8\",\"hot_pepper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f336.png?v8\",\"hotdog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32d.png?v8\",\"hotel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e8.png?v8\",\"hotsprings\":\"https://github.githubassets.com/images/icons/emoji/unicode/2668.png?v8\",\"hourglass\":\"https://github.githubassets.com/images/icons/emoji/unicode/231b.png?v8\",\"hourglass_flowing_sand\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f3.png?v8\",\"house\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e0.png?v8\",\"house_with_garden\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e1.png?v8\",\"houses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d8.png?v8\",\"hugs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f917.png?v8\",\"hungary\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ed-1f1fa.png?v8\",\"hurtrealbad\":\"https://github.githubassets.com/images/icons/emoji/hurtrealbad.png?v8\",\"hushed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62f.png?v8\",\"hut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d6.png?v8\",\"ice_cream\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f368.png?v8\",\"ice_cube\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ca.png?v8\",\"ice_hockey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d2.png?v8\",\"ice_skate\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f8.png?v8\",\"icecream\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f366.png?v8\",\"iceland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f8.png?v8\",\"id\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f194.png?v8\",\"ideograph_advantage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f250.png?v8\",\"imp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47f.png?v8\",\"inbox_tray\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e5.png?v8\",\"incoming_envelope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e8.png?v8\",\"india\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f3.png?v8\",\"indonesia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1e9.png?v8\",\"infinity\":\"https://github.githubassets.com/images/icons/emoji/unicode/267e.png?v8\",\"information_desk_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8\",\"information_source\":\"https://github.githubassets.com/images/icons/emoji/unicode/2139.png?v8\",\"innocent\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f607.png?v8\",\"interrobang\":\"https://github.githubassets.com/images/icons/emoji/unicode/2049.png?v8\",\"iphone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f1.png?v8\",\"iran\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f7.png?v8\",\"iraq\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f6.png?v8\",\"ireland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1ea.png?v8\",\"isle_of_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f2.png?v8\",\"israel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f1.png?v8\",\"it\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ee-1f1f9.png?v8\",\"izakaya_lantern\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8\",\"jack_o_lantern\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f383.png?v8\",\"jamaica\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f2.png?v8\",\"japan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fe.png?v8\",\"japanese_castle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ef.png?v8\",\"japanese_goblin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47a.png?v8\",\"japanese_ogre\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f479.png?v8\",\"jeans\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f456.png?v8\",\"jersey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1ea.png?v8\",\"jigsaw\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e9.png?v8\",\"jordan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f4.png?v8\",\"joy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f602.png?v8\",\"joy_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f639.png?v8\",\"joystick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f579.png?v8\",\"jp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ef-1f1f5.png?v8\",\"judge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2696.png?v8\",\"juggling_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f939.png?v8\",\"kangaroo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f998.png?v8\",\"kazakhstan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ff.png?v8\",\"kenya\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ea.png?v8\",\"key\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f511.png?v8\",\"keyboard\":\"https://github.githubassets.com/images/icons/emoji/unicode/2328.png?v8\",\"keycap_ten\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51f.png?v8\",\"kick_scooter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f4.png?v8\",\"kimono\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f458.png?v8\",\"kiribati\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ee.png?v8\",\"kiss\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48b.png?v8\",\"kissing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f617.png?v8\",\"kissing_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63d.png?v8\",\"kissing_closed_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61a.png?v8\",\"kissing_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f618.png?v8\",\"kissing_smiling_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f619.png?v8\",\"kite\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa81.png?v8\",\"kiwi_fruit\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95d.png?v8\",\"kneeling_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2642.png?v8\",\"kneeling_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ce.png?v8\",\"kneeling_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ce-2640.png?v8\",\"knife\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52a.png?v8\",\"knot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa2.png?v8\",\"koala\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f428.png?v8\",\"koko\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f201.png?v8\",\"kosovo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fd-1f1f0.png?v8\",\"kr\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f7.png?v8\",\"kuwait\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1fc.png?v8\",\"kyrgyzstan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1ec.png?v8\",\"lab_coat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97c.png?v8\",\"label\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f7.png?v8\",\"lacrosse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94d.png?v8\",\"ladder\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9c.png?v8\",\"lady_beetle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41e.png?v8\",\"lantern\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ee.png?v8\",\"laos\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e6.png?v8\",\"large_blue_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f535.png?v8\",\"large_blue_diamond\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f537.png?v8\",\"large_orange_diamond\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f536.png?v8\",\"last_quarter_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f317.png?v8\",\"last_quarter_moon_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31c.png?v8\",\"latin_cross\":\"https://github.githubassets.com/images/icons/emoji/unicode/271d.png?v8\",\"latvia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fb.png?v8\",\"laughing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8\",\"leafy_green\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96c.png?v8\",\"leaves\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f343.png?v8\",\"lebanon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e7.png?v8\",\"ledger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d2.png?v8\",\"left_luggage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c5.png?v8\",\"left_right_arrow\":\"https://github.githubassets.com/images/icons/emoji/unicode/2194.png?v8\",\"left_speech_bubble\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5e8.png?v8\",\"leftwards_arrow_with_hook\":\"https://github.githubassets.com/images/icons/emoji/unicode/21a9.png?v8\",\"leg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b5.png?v8\",\"lemon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34b.png?v8\",\"leo\":\"https://github.githubassets.com/images/icons/emoji/unicode/264c.png?v8\",\"leopard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f406.png?v8\",\"lesotho\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f8.png?v8\",\"level_slider\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f39a.png?v8\",\"liberia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f7.png?v8\",\"libra\":\"https://github.githubassets.com/images/icons/emoji/unicode/264e.png?v8\",\"libya\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fe.png?v8\",\"liechtenstein\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1ee.png?v8\",\"light_rail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f688.png?v8\",\"link\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f517.png?v8\",\"lion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f981.png?v8\",\"lips\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f444.png?v8\",\"lipstick\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f484.png?v8\",\"lithuania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f9.png?v8\",\"lizard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98e.png?v8\",\"llama\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f999.png?v8\",\"lobster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99e.png?v8\",\"lock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f512.png?v8\",\"lock_with_ink_pen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50f.png?v8\",\"lollipop\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f36d.png?v8\",\"long_drum\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa98.png?v8\",\"loop\":\"https://github.githubassets.com/images/icons/emoji/unicode/27bf.png?v8\",\"lotion_bottle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f4.png?v8\",\"lotus_position\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d8.png?v8\",\"lotus_position_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2642.png?v8\",\"lotus_position_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d8-2640.png?v8\",\"loud_sound\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50a.png?v8\",\"loudspeaker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e2.png?v8\",\"love_hotel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e9.png?v8\",\"love_letter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48c.png?v8\",\"love_you_gesture\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91f.png?v8\",\"low_brightness\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f505.png?v8\",\"luggage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f3.png?v8\",\"lungs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fac1.png?v8\",\"luxembourg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1fa.png?v8\",\"lying_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f925.png?v8\",\"m\":\"https://github.githubassets.com/images/icons/emoji/unicode/24c2.png?v8\",\"macau\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f4.png?v8\",\"macedonia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f0.png?v8\",\"madagascar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ec.png?v8\",\"mag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50d.png?v8\",\"mag_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png?v8\",\"mage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d9.png?v8\",\"mage_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2642.png?v8\",\"mage_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d9-2640.png?v8\",\"magic_wand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa84.png?v8\",\"magnet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f2.png?v8\",\"mahjong\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f004.png?v8\",\"mailbox\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4eb.png?v8\",\"mailbox_closed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ea.png?v8\",\"mailbox_with_mail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ec.png?v8\",\"mailbox_with_no_mail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ed.png?v8\",\"malawi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fc.png?v8\",\"malaysia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fe.png?v8\",\"maldives\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fb.png?v8\",\"male_detective\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f575-2642.png?v8\",\"male_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/2642.png?v8\",\"mali\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f1.png?v8\",\"malta\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f9.png?v8\",\"mammoth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a3.png?v8\",\"man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468.png?v8\",\"man_artist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a8.png?v8\",\"man_astronaut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f680.png?v8\",\"man_beard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2642.png?v8\",\"man_cartwheeling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f938-2642.png?v8\",\"man_cook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f373.png?v8\",\"man_dancing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f57a.png?v8\",\"man_facepalming\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f926-2642.png?v8\",\"man_factory_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3ed.png?v8\",\"man_farmer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f33e.png?v8\",\"man_feeding_baby\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f37c.png?v8\",\"man_firefighter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f692.png?v8\",\"man_health_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2695.png?v8\",\"man_in_manual_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bd.png?v8\",\"man_in_motorized_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9bc.png?v8\",\"man_in_tuxedo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f935-2642.png?v8\",\"man_judge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2696.png?v8\",\"man_juggling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f939-2642.png?v8\",\"man_mechanic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f527.png?v8\",\"man_office_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bc.png?v8\",\"man_pilot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-2708.png?v8\",\"man_playing_handball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2642.png?v8\",\"man_playing_water_polo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2642.png?v8\",\"man_scientist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f52c.png?v8\",\"man_shrugging\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f937-2642.png?v8\",\"man_singer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3a4.png?v8\",\"man_student\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f393.png?v8\",\"man_teacher\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f3eb.png?v8\",\"man_technologist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f4bb.png?v8\",\"man_with_gua_pi_mao\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f472.png?v8\",\"man_with_probing_cane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9af.png?v8\",\"man_with_turban\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f473-2642.png?v8\",\"man_with_veil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f470-2642.png?v8\",\"mandarin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8\",\"mango\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96d.png?v8\",\"mans_shoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8\",\"mantelpiece_clock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f570.png?v8\",\"manual_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9bd.png?v8\",\"maple_leaf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f341.png?v8\",\"marshall_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ed.png?v8\",\"martial_arts_uniform\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94b.png?v8\",\"martinique\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f6.png?v8\",\"mask\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f637.png?v8\",\"massage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f486.png?v8\",\"massage_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f486-2642.png?v8\",\"massage_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f486-2640.png?v8\",\"mate\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c9.png?v8\",\"mauritania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f7.png?v8\",\"mauritius\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fa.png?v8\",\"mayotte\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1f9.png?v8\",\"meat_on_bone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f356.png?v8\",\"mechanic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f527.png?v8\",\"mechanical_arm\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9be.png?v8\",\"mechanical_leg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9bf.png?v8\",\"medal_military\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f396.png?v8\",\"medal_sports\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c5.png?v8\",\"medical_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/2695.png?v8\",\"mega\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e3.png?v8\",\"melon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f348.png?v8\",\"memo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8\",\"men_wrestling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2642.png?v8\",\"mending_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/2764-1fa79.png?v8\",\"menorah\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f54e.png?v8\",\"mens\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b9.png?v8\",\"mermaid\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2640.png?v8\",\"merman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dc-2642.png?v8\",\"merperson\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9dc.png?v8\",\"metal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f918.png?v8\",\"metro\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f687.png?v8\",\"mexico\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1fd.png?v8\",\"microbe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a0.png?v8\",\"micronesia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1eb-1f1f2.png?v8\",\"microphone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a4.png?v8\",\"microscope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52c.png?v8\",\"middle_finger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f595.png?v8\",\"military_helmet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa96.png?v8\",\"milk_glass\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95b.png?v8\",\"milky_way\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30c.png?v8\",\"minibus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f690.png?v8\",\"minidisc\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4bd.png?v8\",\"mirror\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9e.png?v8\",\"mobile_phone_off\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f4.png?v8\",\"moldova\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e9.png?v8\",\"monaco\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e8.png?v8\",\"money_mouth_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f911.png?v8\",\"money_with_wings\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b8.png?v8\",\"moneybag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b0.png?v8\",\"mongolia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f3.png?v8\",\"monkey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f412.png?v8\",\"monkey_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f435.png?v8\",\"monocle_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d0.png?v8\",\"monorail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69d.png?v8\",\"montenegro\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ea.png?v8\",\"montserrat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f8.png?v8\",\"moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8\",\"moon_cake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96e.png?v8\",\"morocco\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1e6.png?v8\",\"mortar_board\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f393.png?v8\",\"mosque\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f54c.png?v8\",\"mosquito\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99f.png?v8\",\"motor_boat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e5.png?v8\",\"motor_scooter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f5.png?v8\",\"motorcycle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cd.png?v8\",\"motorized_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9bc.png?v8\",\"motorway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e3.png?v8\",\"mount_fuji\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fb.png?v8\",\"mountain\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f0.png?v8\",\"mountain_bicyclist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b5.png?v8\",\"mountain_biking_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2642.png?v8\",\"mountain_biking_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b5-2640.png?v8\",\"mountain_cableway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a0.png?v8\",\"mountain_railway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69e.png?v8\",\"mountain_snow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d4.png?v8\",\"mouse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42d.png?v8\",\"mouse2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f401.png?v8\",\"mouse_trap\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa4.png?v8\",\"movie_camera\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a5.png?v8\",\"moyai\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5ff.png?v8\",\"mozambique\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1ff.png?v8\",\"mrs_claus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f936.png?v8\",\"muscle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4aa.png?v8\",\"mushroom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f344.png?v8\",\"musical_keyboard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b9.png?v8\",\"musical_note\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b5.png?v8\",\"musical_score\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3bc.png?v8\",\"mute\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f507.png?v8\",\"mx_claus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f384.png?v8\",\"myanmar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f2.png?v8\",\"nail_care\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f485.png?v8\",\"name_badge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4db.png?v8\",\"namibia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e6.png?v8\",\"national_park\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3de.png?v8\",\"nauru\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f7.png?v8\",\"nauseated_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f922.png?v8\",\"nazar_amulet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ff.png?v8\",\"neckbeard\":\"https://github.githubassets.com/images/icons/emoji/neckbeard.png?v8\",\"necktie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f454.png?v8\",\"negative_squared_cross_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/274e.png?v8\",\"nepal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f5.png?v8\",\"nerd_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f913.png?v8\",\"nesting_dolls\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa86.png?v8\",\"netherlands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f1.png?v8\",\"neutral_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f610.png?v8\",\"new\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f195.png?v8\",\"new_caledonia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1e8.png?v8\",\"new_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f311.png?v8\",\"new_moon_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31a.png?v8\",\"new_zealand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ff.png?v8\",\"newspaper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f0.png?v8\",\"newspaper_roll\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5de.png?v8\",\"next_track_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ed.png?v8\",\"ng\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f196.png?v8\",\"ng_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8\",\"ng_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8\",\"nicaragua\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ee.png?v8\",\"niger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ea.png?v8\",\"nigeria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1ec.png?v8\",\"night_with_stars\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f303.png?v8\",\"nine\":\"https://github.githubassets.com/images/icons/emoji/unicode/0039-20e3.png?v8\",\"ninja\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f977.png?v8\",\"niue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1fa.png?v8\",\"no_bell\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f515.png?v8\",\"no_bicycles\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b3.png?v8\",\"no_entry\":\"https://github.githubassets.com/images/icons/emoji/unicode/26d4.png?v8\",\"no_entry_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ab.png?v8\",\"no_good\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645.png?v8\",\"no_good_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645-2642.png?v8\",\"no_good_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f645-2640.png?v8\",\"no_mobile_phones\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f5.png?v8\",\"no_mouth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f636.png?v8\",\"no_pedestrians\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b7.png?v8\",\"no_smoking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ad.png?v8\",\"non-potable_water\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b1.png?v8\",\"norfolk_island\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1eb.png?v8\",\"north_korea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f5.png?v8\",\"northern_mariana_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1f5.png?v8\",\"norway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f3-1f1f4.png?v8\",\"nose\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f443.png?v8\",\"notebook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d3.png?v8\",\"notebook_with_decorative_cover\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d4.png?v8\",\"notes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b6.png?v8\",\"nut_and_bolt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f529.png?v8\",\"o\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b55.png?v8\",\"o2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f17e.png?v8\",\"ocean\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30a.png?v8\",\"octocat\":\"https://github.githubassets.com/images/icons/emoji/octocat.png?v8\",\"octopus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f419.png?v8\",\"oden\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f362.png?v8\",\"office\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e2.png?v8\",\"office_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bc.png?v8\",\"oil_drum\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e2.png?v8\",\"ok\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f197.png?v8\",\"ok_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44c.png?v8\",\"ok_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f646-2642.png?v8\",\"ok_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f646.png?v8\",\"ok_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f646-2640.png?v8\",\"old_key\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5dd.png?v8\",\"older_adult\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d3.png?v8\",\"older_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f474.png?v8\",\"older_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f475.png?v8\",\"olive\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad2.png?v8\",\"om\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f549.png?v8\",\"oman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f4-1f1f2.png?v8\",\"on\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51b.png?v8\",\"oncoming_automobile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f698.png?v8\",\"oncoming_bus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68d.png?v8\",\"oncoming_police_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f694.png?v8\",\"oncoming_taxi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f696.png?v8\",\"one\":\"https://github.githubassets.com/images/icons/emoji/unicode/0031-20e3.png?v8\",\"one_piece_swimsuit\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa71.png?v8\",\"onion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c5.png?v8\",\"open_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d6.png?v8\",\"open_file_folder\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c2.png?v8\",\"open_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f450.png?v8\",\"open_mouth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62e.png?v8\",\"open_umbrella\":\"https://github.githubassets.com/images/icons/emoji/unicode/2602.png?v8\",\"ophiuchus\":\"https://github.githubassets.com/images/icons/emoji/unicode/26ce.png?v8\",\"orange\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8\",\"orange_book\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d9.png?v8\",\"orange_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e0.png?v8\",\"orange_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e1.png?v8\",\"orange_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e7.png?v8\",\"orangutan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a7.png?v8\",\"orthodox_cross\":\"https://github.githubassets.com/images/icons/emoji/unicode/2626.png?v8\",\"otter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a6.png?v8\",\"outbox_tray\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e4.png?v8\",\"owl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f989.png?v8\",\"ox\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f402.png?v8\",\"oyster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9aa.png?v8\",\"package\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e6.png?v8\",\"page_facing_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c4.png?v8\",\"page_with_curl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4c3.png?v8\",\"pager\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4df.png?v8\",\"paintbrush\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f58c.png?v8\",\"pakistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f0.png?v8\",\"palau\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fc.png?v8\",\"palestinian_territories\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f8.png?v8\",\"palm_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f334.png?v8\",\"palms_up_together\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f932.png?v8\",\"panama\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1e6.png?v8\",\"pancakes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95e.png?v8\",\"panda_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43c.png?v8\",\"paperclip\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ce.png?v8\",\"paperclips\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f587.png?v8\",\"papua_new_guinea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ec.png?v8\",\"parachute\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa82.png?v8\",\"paraguay\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1fe.png?v8\",\"parasol_on_ground\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f1.png?v8\",\"parking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f17f.png?v8\",\"parrot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99c.png?v8\",\"part_alternation_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/303d.png?v8\",\"partly_sunny\":\"https://github.githubassets.com/images/icons/emoji/unicode/26c5.png?v8\",\"partying_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f973.png?v8\",\"passenger_ship\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f3.png?v8\",\"passport_control\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6c2.png?v8\",\"pause_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f8.png?v8\",\"paw_prints\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43e.png?v8\",\"peace_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/262e.png?v8\",\"peach\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f351.png?v8\",\"peacock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99a.png?v8\",\"peanuts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f95c.png?v8\",\"pear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f350.png?v8\",\"pen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f58a.png?v8\",\"pencil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4dd.png?v8\",\"pencil2\":\"https://github.githubassets.com/images/icons/emoji/unicode/270f.png?v8\",\"penguin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f427.png?v8\",\"pensive\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f614.png?v8\",\"people_holding_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f91d-1f9d1.png?v8\",\"people_hugging\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fac2.png?v8\",\"performing_arts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ad.png?v8\",\"persevere\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f623.png?v8\",\"person_bald\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b2.png?v8\",\"person_curly_hair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b1.png?v8\",\"person_feeding_baby\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f37c.png?v8\",\"person_fencing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93a.png?v8\",\"person_in_manual_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bd.png?v8\",\"person_in_motorized_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9bc.png?v8\",\"person_in_tuxedo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f935.png?v8\",\"person_red_hair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b0.png?v8\",\"person_white_hair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9b3.png?v8\",\"person_with_probing_cane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f9af.png?v8\",\"person_with_turban\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f473.png?v8\",\"person_with_veil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f470.png?v8\",\"peru\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ea.png?v8\",\"petri_dish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9eb.png?v8\",\"philippines\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1ed.png?v8\",\"phone\":\"https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8\",\"pick\":\"https://github.githubassets.com/images/icons/emoji/unicode/26cf.png?v8\",\"pickup_truck\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6fb.png?v8\",\"pie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f967.png?v8\",\"pig\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f437.png?v8\",\"pig2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f416.png?v8\",\"pig_nose\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43d.png?v8\",\"pill\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48a.png?v8\",\"pilot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-2708.png?v8\",\"pinata\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa85.png?v8\",\"pinched_fingers\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f90c.png?v8\",\"pinching_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f90f.png?v8\",\"pineapple\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34d.png?v8\",\"ping_pong\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d3.png?v8\",\"pirate_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-2620.png?v8\",\"pisces\":\"https://github.githubassets.com/images/icons/emoji/unicode/2653.png?v8\",\"pitcairn_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f3.png?v8\",\"pizza\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f355.png?v8\",\"placard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa7.png?v8\",\"place_of_worship\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d0.png?v8\",\"plate_with_cutlery\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37d.png?v8\",\"play_or_pause_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ef.png?v8\",\"pleading_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97a.png?v8\",\"plunger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa0.png?v8\",\"point_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f447.png?v8\",\"point_left\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f448.png?v8\",\"point_right\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f449.png?v8\",\"point_up\":\"https://github.githubassets.com/images/icons/emoji/unicode/261d.png?v8\",\"point_up_2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f446.png?v8\",\"poland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f1.png?v8\",\"polar_bear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43b-2744.png?v8\",\"police_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f693.png?v8\",\"police_officer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46e.png?v8\",\"policeman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2642.png?v8\",\"policewoman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46e-2640.png?v8\",\"poodle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f429.png?v8\",\"poop\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a9.png?v8\",\"popcorn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f37f.png?v8\",\"portugal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f9.png?v8\",\"post_office\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3e3.png?v8\",\"postal_horn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ef.png?v8\",\"postbox\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ee.png?v8\",\"potable_water\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b0.png?v8\",\"potato\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f954.png?v8\",\"potted_plant\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab4.png?v8\",\"pouch\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45d.png?v8\",\"poultry_leg\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f357.png?v8\",\"pound\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b7.png?v8\",\"pout\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8\",\"pouting_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63e.png?v8\",\"pouting_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64e.png?v8\",\"pouting_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2642.png?v8\",\"pouting_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64e-2640.png?v8\",\"pray\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64f.png?v8\",\"prayer_beads\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ff.png?v8\",\"pregnant_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f930.png?v8\",\"pretzel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f968.png?v8\",\"previous_track_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ee.png?v8\",\"prince\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f934.png?v8\",\"princess\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f478.png?v8\",\"printer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5a8.png?v8\",\"probing_cane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9af.png?v8\",\"puerto_rico\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f7.png?v8\",\"punch\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44a.png?v8\",\"purple_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e3.png?v8\",\"purple_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49c.png?v8\",\"purple_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7ea.png?v8\",\"purse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45b.png?v8\",\"pushpin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4cc.png?v8\",\"put_litter_in_its_place\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ae.png?v8\",\"qatar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f6-1f1e6.png?v8\",\"question\":\"https://github.githubassets.com/images/icons/emoji/unicode/2753.png?v8\",\"rabbit\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f430.png?v8\",\"rabbit2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f407.png?v8\",\"raccoon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f99d.png?v8\",\"racehorse\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40e.png?v8\",\"racing_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ce.png?v8\",\"radio\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4fb.png?v8\",\"radio_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f518.png?v8\",\"radioactive\":\"https://github.githubassets.com/images/icons/emoji/unicode/2622.png?v8\",\"rage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f621.png?v8\",\"rage1\":\"https://github.githubassets.com/images/icons/emoji/rage1.png?v8\",\"rage2\":\"https://github.githubassets.com/images/icons/emoji/rage2.png?v8\",\"rage3\":\"https://github.githubassets.com/images/icons/emoji/rage3.png?v8\",\"rage4\":\"https://github.githubassets.com/images/icons/emoji/rage4.png?v8\",\"railway_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f683.png?v8\",\"railway_track\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e4.png?v8\",\"rainbow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f308.png?v8\",\"rainbow_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-1f308.png?v8\",\"raised_back_of_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f91a.png?v8\",\"raised_eyebrow\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f928.png?v8\",\"raised_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/270b.png?v8\",\"raised_hand_with_fingers_splayed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f590.png?v8\",\"raised_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64c.png?v8\",\"raising_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64b.png?v8\",\"raising_hand_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2642.png?v8\",\"raising_hand_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64b-2640.png?v8\",\"ram\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40f.png?v8\",\"ramen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35c.png?v8\",\"rat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f400.png?v8\",\"razor\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa92.png?v8\",\"receipt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fe.png?v8\",\"record_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23fa.png?v8\",\"recycle\":\"https://github.githubassets.com/images/icons/emoji/unicode/267b.png?v8\",\"red_car\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f697.png?v8\",\"red_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f534.png?v8\",\"red_envelope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e7.png?v8\",\"red_haired_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b0.png?v8\",\"red_haired_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b0.png?v8\",\"red_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e5.png?v8\",\"registered\":\"https://github.githubassets.com/images/icons/emoji/unicode/00ae.png?v8\",\"relaxed\":\"https://github.githubassets.com/images/icons/emoji/unicode/263a.png?v8\",\"relieved\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60c.png?v8\",\"reminder_ribbon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f397.png?v8\",\"repeat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f501.png?v8\",\"repeat_one\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f502.png?v8\",\"rescue_worker_helmet\":\"https://github.githubassets.com/images/icons/emoji/unicode/26d1.png?v8\",\"restroom\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6bb.png?v8\",\"reunion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1ea.png?v8\",\"revolving_hearts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49e.png?v8\",\"rewind\":\"https://github.githubassets.com/images/icons/emoji/unicode/23ea.png?v8\",\"rhinoceros\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f98f.png?v8\",\"ribbon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f380.png?v8\",\"rice\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35a.png?v8\",\"rice_ball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f359.png?v8\",\"rice_cracker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f358.png?v8\",\"rice_scene\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f391.png?v8\",\"right_anger_bubble\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5ef.png?v8\",\"ring\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f48d.png?v8\",\"ringed_planet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa90.png?v8\",\"robot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f916.png?v8\",\"rock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa8.png?v8\",\"rocket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f680.png?v8\",\"rofl\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f923.png?v8\",\"roll_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f644.png?v8\",\"roll_of_paper\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fb.png?v8\",\"roller_coaster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a2.png?v8\",\"roller_skate\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6fc.png?v8\",\"romania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f4.png?v8\",\"rooster\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f413.png?v8\",\"rose\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f339.png?v8\",\"rosette\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f5.png?v8\",\"rotating_light\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a8.png?v8\",\"round_pushpin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4cd.png?v8\",\"rowboat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a3.png?v8\",\"rowing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2642.png?v8\",\"rowing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a3-2640.png?v8\",\"ru\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8\",\"rugby_football\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c9.png?v8\",\"runner\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8\",\"running\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png?v8\",\"running_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2642.png?v8\",\"running_shirt_with_sash\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3bd.png?v8\",\"running_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c3-2640.png?v8\",\"rwanda\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fc.png?v8\",\"sa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f202.png?v8\",\"safety_pin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f7.png?v8\",\"safety_vest\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ba.png?v8\",\"sagittarius\":\"https://github.githubassets.com/images/icons/emoji/unicode/2650.png?v8\",\"sailboat\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f5.png?v8\",\"sake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f376.png?v8\",\"salt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c2.png?v8\",\"samoa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1f8.png?v8\",\"san_marino\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f2.png?v8\",\"sandal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f461.png?v8\",\"sandwich\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f96a.png?v8\",\"santa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f385.png?v8\",\"sao_tome_principe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f9.png?v8\",\"sari\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f97b.png?v8\",\"sassy_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8\",\"sassy_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8\",\"satellite\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4e1.png?v8\",\"satisfied\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f606.png?v8\",\"saudi_arabia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e6.png?v8\",\"sauna_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2642.png?v8\",\"sauna_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d6.png?v8\",\"sauna_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d6-2640.png?v8\",\"sauropod\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f995.png?v8\",\"saxophone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b7.png?v8\",\"scarf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e3.png?v8\",\"school\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3eb.png?v8\",\"school_satchel\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f392.png?v8\",\"scientist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f52c.png?v8\",\"scissors\":\"https://github.githubassets.com/images/icons/emoji/unicode/2702.png?v8\",\"scorpion\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f982.png?v8\",\"scorpius\":\"https://github.githubassets.com/images/icons/emoji/unicode/264f.png?v8\",\"scotland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0073-e0063-e0074-e007f.png?v8\",\"scream\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f631.png?v8\",\"scream_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f640.png?v8\",\"screwdriver\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9b.png?v8\",\"scroll\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4dc.png?v8\",\"seal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ad.png?v8\",\"seat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ba.png?v8\",\"secret\":\"https://github.githubassets.com/images/icons/emoji/unicode/3299.png?v8\",\"see_no_evil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f648.png?v8\",\"seedling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f331.png?v8\",\"selfie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f933.png?v8\",\"senegal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f3.png?v8\",\"serbia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1f8.png?v8\",\"service_dog\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f415-1f9ba.png?v8\",\"seven\":\"https://github.githubassets.com/images/icons/emoji/unicode/0037-20e3.png?v8\",\"sewing_needle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa1.png?v8\",\"seychelles\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e8.png?v8\",\"shallow_pan_of_food\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f958.png?v8\",\"shamrock\":\"https://github.githubassets.com/images/icons/emoji/unicode/2618.png?v8\",\"shark\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f988.png?v8\",\"shaved_ice\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f367.png?v8\",\"sheep\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f411.png?v8\",\"shell\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f41a.png?v8\",\"shield\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e1.png?v8\",\"shinto_shrine\":\"https://github.githubassets.com/images/icons/emoji/unicode/26e9.png?v8\",\"ship\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a2.png?v8\",\"shipit\":\"https://github.githubassets.com/images/icons/emoji/shipit.png?v8\",\"shirt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8\",\"shoe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45e.png?v8\",\"shopping\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6cd.png?v8\",\"shopping_cart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d2.png?v8\",\"shorts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa73.png?v8\",\"shower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6bf.png?v8\",\"shrimp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f990.png?v8\",\"shrug\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f937.png?v8\",\"shushing_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92b.png?v8\",\"sierra_leone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f1.png?v8\",\"signal_strength\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f6.png?v8\",\"singapore\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ec.png?v8\",\"singer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3a4.png?v8\",\"sint_maarten\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fd.png?v8\",\"six\":\"https://github.githubassets.com/images/icons/emoji/unicode/0036-20e3.png?v8\",\"six_pointed_star\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52f.png?v8\",\"skateboard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f9.png?v8\",\"ski\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3bf.png?v8\",\"skier\":\"https://github.githubassets.com/images/icons/emoji/unicode/26f7.png?v8\",\"skull\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f480.png?v8\",\"skull_and_crossbones\":\"https://github.githubassets.com/images/icons/emoji/unicode/2620.png?v8\",\"skunk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a8.png?v8\",\"sled\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6f7.png?v8\",\"sleeping\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f634.png?v8\",\"sleeping_bed\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6cc.png?v8\",\"sleepy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62a.png?v8\",\"slightly_frowning_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f641.png?v8\",\"slightly_smiling_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f642.png?v8\",\"slot_machine\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3b0.png?v8\",\"sloth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a5.png?v8\",\"slovakia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f0.png?v8\",\"slovenia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ee.png?v8\",\"small_airplane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6e9.png?v8\",\"small_blue_diamond\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f539.png?v8\",\"small_orange_diamond\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f538.png?v8\",\"small_red_triangle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f53a.png?v8\",\"small_red_triangle_down\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f53b.png?v8\",\"smile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f604.png?v8\",\"smile_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f638.png?v8\",\"smiley\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f603.png?v8\",\"smiley_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63a.png?v8\",\"smiling_face_with_tear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f972.png?v8\",\"smiling_face_with_three_hearts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f970.png?v8\",\"smiling_imp\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f608.png?v8\",\"smirk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60f.png?v8\",\"smirk_cat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f63c.png?v8\",\"smoking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ac.png?v8\",\"snail\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40c.png?v8\",\"snake\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png?v8\",\"sneezing_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f927.png?v8\",\"snowboarder\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c2.png?v8\",\"snowflake\":\"https://github.githubassets.com/images/icons/emoji/unicode/2744.png?v8\",\"snowman\":\"https://github.githubassets.com/images/icons/emoji/unicode/26c4.png?v8\",\"snowman_with_snow\":\"https://github.githubassets.com/images/icons/emoji/unicode/2603.png?v8\",\"soap\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fc.png?v8\",\"sob\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62d.png?v8\",\"soccer\":\"https://github.githubassets.com/images/icons/emoji/unicode/26bd.png?v8\",\"socks\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9e6.png?v8\",\"softball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f94e.png?v8\",\"solomon_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e7.png?v8\",\"somalia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f4.png?v8\",\"soon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51c.png?v8\",\"sos\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f198.png?v8\",\"sound\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f509.png?v8\",\"south_africa\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1e6.png?v8\",\"south_georgia_south_sandwich_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1f8.png?v8\",\"south_sudan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f8.png?v8\",\"space_invader\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f47e.png?v8\",\"spades\":\"https://github.githubassets.com/images/icons/emoji/unicode/2660.png?v8\",\"spaghetti\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f35d.png?v8\",\"sparkle\":\"https://github.githubassets.com/images/icons/emoji/unicode/2747.png?v8\",\"sparkler\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f387.png?v8\",\"sparkles\":\"https://github.githubassets.com/images/icons/emoji/unicode/2728.png?v8\",\"sparkling_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f496.png?v8\",\"speak_no_evil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f64a.png?v8\",\"speaker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f508.png?v8\",\"speaking_head\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5e3.png?v8\",\"speech_balloon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ac.png?v8\",\"speedboat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a4.png?v8\",\"spider\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f577.png?v8\",\"spider_web\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f578.png?v8\",\"spiral_calendar\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5d3.png?v8\",\"spiral_notepad\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5d2.png?v8\",\"sponge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9fd.png?v8\",\"spoon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f944.png?v8\",\"squid\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f991.png?v8\",\"sri_lanka\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1f0.png?v8\",\"st_barthelemy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e7-1f1f1.png?v8\",\"st_helena\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ed.png?v8\",\"st_kitts_nevis\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f0-1f1f3.png?v8\",\"st_lucia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f1-1f1e8.png?v8\",\"st_martin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f2-1f1eb.png?v8\",\"st_pierre_miquelon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f5-1f1f2.png?v8\",\"st_vincent_grenadines\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e8.png?v8\",\"stadium\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3df.png?v8\",\"standing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2642.png?v8\",\"standing_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cd.png?v8\",\"standing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9cd-2640.png?v8\",\"star\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b50.png?v8\",\"star2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31f.png?v8\",\"star_and_crescent\":\"https://github.githubassets.com/images/icons/emoji/unicode/262a.png?v8\",\"star_of_david\":\"https://github.githubassets.com/images/icons/emoji/unicode/2721.png?v8\",\"star_struck\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f929.png?v8\",\"stars\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f320.png?v8\",\"station\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f689.png?v8\",\"statue_of_liberty\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fd.png?v8\",\"steam_locomotive\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f682.png?v8\",\"stethoscope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa7a.png?v8\",\"stew\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f372.png?v8\",\"stop_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f9.png?v8\",\"stop_sign\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6d1.png?v8\",\"stopwatch\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f1.png?v8\",\"straight_ruler\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4cf.png?v8\",\"strawberry\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f353.png?v8\",\"stuck_out_tongue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61b.png?v8\",\"stuck_out_tongue_closed_eyes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61d.png?v8\",\"stuck_out_tongue_winking_eye\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61c.png?v8\",\"student\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f393.png?v8\",\"studio_microphone\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f399.png?v8\",\"stuffed_flatbread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f959.png?v8\",\"sudan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1e9.png?v8\",\"sun_behind_large_cloud\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f325.png?v8\",\"sun_behind_rain_cloud\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f326.png?v8\",\"sun_behind_small_cloud\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f324.png?v8\",\"sun_with_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f31e.png?v8\",\"sunflower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f33b.png?v8\",\"sunglasses\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60e.png?v8\",\"sunny\":\"https://github.githubassets.com/images/icons/emoji/unicode/2600.png?v8\",\"sunrise\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f305.png?v8\",\"sunrise_over_mountains\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f304.png?v8\",\"superhero\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b8.png?v8\",\"superhero_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2642.png?v8\",\"superhero_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b8-2640.png?v8\",\"supervillain\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b9.png?v8\",\"supervillain_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2642.png?v8\",\"supervillain_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b9-2640.png?v8\",\"surfer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png?v8\",\"surfing_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2642.png?v8\",\"surfing_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c4-2640.png?v8\",\"suriname\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1f7.png?v8\",\"sushi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f363.png?v8\",\"suspect\":\"https://github.githubassets.com/images/icons/emoji/suspect.png?v8\",\"suspension_railway\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69f.png?v8\",\"svalbard_jan_mayen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ef.png?v8\",\"swan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9a2.png?v8\",\"swaziland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ff.png?v8\",\"sweat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f613.png?v8\",\"sweat_drops\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a6.png?v8\",\"sweat_smile\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f605.png?v8\",\"sweden\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1ea.png?v8\",\"sweet_potato\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f360.png?v8\",\"swim_brief\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa72.png?v8\",\"swimmer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ca.png?v8\",\"swimming_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2642.png?v8\",\"swimming_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ca-2640.png?v8\",\"switzerland\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1ed.png?v8\",\"symbols\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f523.png?v8\",\"synagogue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f54d.png?v8\",\"syria\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f8-1f1fe.png?v8\",\"syringe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f489.png?v8\",\"t-rex\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f996.png?v8\",\"taco\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32e.png?v8\",\"tada\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f389.png?v8\",\"taiwan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fc.png?v8\",\"tajikistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ef.png?v8\",\"takeout_box\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f961.png?v8\",\"tamale\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad4.png?v8\",\"tanabata_tree\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f38b.png?v8\",\"tangerine\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f34a.png?v8\",\"tanzania\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ff.png?v8\",\"taurus\":\"https://github.githubassets.com/images/icons/emoji/unicode/2649.png?v8\",\"taxi\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f695.png?v8\",\"tea\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f375.png?v8\",\"teacher\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f3eb.png?v8\",\"teapot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fad6.png?v8\",\"technologist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d1-1f4bb.png?v8\",\"teddy_bear\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f8.png?v8\",\"telephone\":\"https://github.githubassets.com/images/icons/emoji/unicode/260e.png?v8\",\"telephone_receiver\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4de.png?v8\",\"telescope\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f52d.png?v8\",\"tennis\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3be.png?v8\",\"tent\":\"https://github.githubassets.com/images/icons/emoji/unicode/26fa.png?v8\",\"test_tube\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9ea.png?v8\",\"thailand\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ed.png?v8\",\"thermometer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f321.png?v8\",\"thinking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f914.png?v8\",\"thong_sandal\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa74.png?v8\",\"thought_balloon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ad.png?v8\",\"thread\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f5.png?v8\",\"three\":\"https://github.githubassets.com/images/icons/emoji/unicode/0033-20e3.png?v8\",\"thumbsdown\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44e.png?v8\",\"thumbsup\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44d.png?v8\",\"ticket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ab.png?v8\",\"tickets\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f39f.png?v8\",\"tiger\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png?v8\",\"tiger2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f405.png?v8\",\"timer_clock\":\"https://github.githubassets.com/images/icons/emoji/unicode/23f2.png?v8\",\"timor_leste\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f1.png?v8\",\"tipping_hand_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481-2642.png?v8\",\"tipping_hand_person\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481.png?v8\",\"tipping_hand_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f481-2640.png?v8\",\"tired_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f62b.png?v8\",\"tm\":\"https://github.githubassets.com/images/icons/emoji/unicode/2122.png?v8\",\"togo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1ec.png?v8\",\"toilet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6bd.png?v8\",\"tokelau\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f0.png?v8\",\"tokyo_tower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fc.png?v8\",\"tomato\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f345.png?v8\",\"tonga\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f4.png?v8\",\"tongue\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f445.png?v8\",\"toolbox\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f0.png?v8\",\"tooth\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9b7.png?v8\",\"toothbrush\":\"https://github.githubassets.com/images/icons/emoji/unicode/1faa5.png?v8\",\"top\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51d.png?v8\",\"tophat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3a9.png?v8\",\"tornado\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32a.png?v8\",\"tr\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f7.png?v8\",\"trackball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5b2.png?v8\",\"tractor\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69c.png?v8\",\"traffic_light\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a5.png?v8\",\"train\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68b.png?v8\",\"train2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f686.png?v8\",\"tram\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68a.png?v8\",\"transgender_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f3-26a7.png?v8\",\"transgender_symbol\":\"https://github.githubassets.com/images/icons/emoji/unicode/26a7.png?v8\",\"triangular_flag_on_post\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a9.png?v8\",\"triangular_ruler\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4d0.png?v8\",\"trident\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f531.png?v8\",\"trinidad_tobago\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f9.png?v8\",\"tristan_da_cunha\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e6.png?v8\",\"triumph\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f624.png?v8\",\"trolleybus\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f68e.png?v8\",\"trollface\":\"https://github.githubassets.com/images/icons/emoji/trollface.png?v8\",\"trophy\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png?v8\",\"tropical_drink\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f379.png?v8\",\"tropical_fish\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f420.png?v8\",\"truck\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f69a.png?v8\",\"trumpet\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ba.png?v8\",\"tshirt\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f455.png?v8\",\"tulip\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f337.png?v8\",\"tumbler_glass\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f943.png?v8\",\"tunisia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f3.png?v8\",\"turkey\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f983.png?v8\",\"turkmenistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1f2.png?v8\",\"turks_caicos_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1e8.png?v8\",\"turtle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f422.png?v8\",\"tuvalu\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f9-1f1fb.png?v8\",\"tv\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4fa.png?v8\",\"twisted_rightwards_arrows\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f500.png?v8\",\"two\":\"https://github.githubassets.com/images/icons/emoji/unicode/0032-20e3.png?v8\",\"two_hearts\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f495.png?v8\",\"two_men_holding_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46c.png?v8\",\"two_women_holding_hands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f46d.png?v8\",\"u5272\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f239.png?v8\",\"u5408\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f234.png?v8\",\"u55b6\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f23a.png?v8\",\"u6307\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f22f.png?v8\",\"u6708\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f237.png?v8\",\"u6709\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f236.png?v8\",\"u6e80\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f235.png?v8\",\"u7121\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f21a.png?v8\",\"u7533\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f238.png?v8\",\"u7981\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f232.png?v8\",\"u7a7a\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f233.png?v8\",\"uganda\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ec.png?v8\",\"uk\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8\",\"ukraine\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1e6.png?v8\",\"umbrella\":\"https://github.githubassets.com/images/icons/emoji/unicode/2614.png?v8\",\"unamused\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f612.png?v8\",\"underage\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f51e.png?v8\",\"unicorn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f984.png?v8\",\"united_arab_emirates\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e6-1f1ea.png?v8\",\"united_nations\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f3.png?v8\",\"unlock\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f513.png?v8\",\"up\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f199.png?v8\",\"upside_down_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f643.png?v8\",\"uruguay\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1fe.png?v8\",\"us\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f8.png?v8\",\"us_outlying_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1f2.png?v8\",\"us_virgin_islands\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ee.png?v8\",\"uzbekistan\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fa-1f1ff.png?v8\",\"v\":\"https://github.githubassets.com/images/icons/emoji/unicode/270c.png?v8\",\"vampire\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9db.png?v8\",\"vampire_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2642.png?v8\",\"vampire_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9db-2640.png?v8\",\"vanuatu\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1fa.png?v8\",\"vatican_city\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1e6.png?v8\",\"venezuela\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1ea.png?v8\",\"vertical_traffic_light\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6a6.png?v8\",\"vhs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4fc.png?v8\",\"vibration_mode\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f3.png?v8\",\"video_camera\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4f9.png?v8\",\"video_game\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3ae.png?v8\",\"vietnam\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fb-1f1f3.png?v8\",\"violin\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3bb.png?v8\",\"virgo\":\"https://github.githubassets.com/images/icons/emoji/unicode/264d.png?v8\",\"volcano\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f30b.png?v8\",\"volleyball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3d0.png?v8\",\"vomiting_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92e.png?v8\",\"vs\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f19a.png?v8\",\"vulcan_salute\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f596.png?v8\",\"waffle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9c7.png?v8\",\"wales\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f4-e0067-e0062-e0077-e006c-e0073-e007f.png?v8\",\"walking\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b6.png?v8\",\"walking_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2642.png?v8\",\"walking_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6b6-2640.png?v8\",\"wallis_futuna\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fc-1f1eb.png?v8\",\"waning_crescent_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f318.png?v8\",\"waning_gibbous_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f316.png?v8\",\"warning\":\"https://github.githubassets.com/images/icons/emoji/unicode/26a0.png?v8\",\"wastebasket\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5d1.png?v8\",\"watch\":\"https://github.githubassets.com/images/icons/emoji/unicode/231a.png?v8\",\"water_buffalo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f403.png?v8\",\"water_polo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93d.png?v8\",\"watermelon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f349.png?v8\",\"wave\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f44b.png?v8\",\"wavy_dash\":\"https://github.githubassets.com/images/icons/emoji/unicode/3030.png?v8\",\"waxing_crescent_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f312.png?v8\",\"waxing_gibbous_moon\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f314.png?v8\",\"wc\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6be.png?v8\",\"weary\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f629.png?v8\",\"wedding\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f492.png?v8\",\"weight_lifting\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cb.png?v8\",\"weight_lifting_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2642.png?v8\",\"weight_lifting_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3cb-2640.png?v8\",\"western_sahara\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1ed.png?v8\",\"whale\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f433.png?v8\",\"whale2\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f40b.png?v8\",\"wheel_of_dharma\":\"https://github.githubassets.com/images/icons/emoji/unicode/2638.png?v8\",\"wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/267f.png?v8\",\"white_check_mark\":\"https://github.githubassets.com/images/icons/emoji/unicode/2705.png?v8\",\"white_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/26aa.png?v8\",\"white_flag\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f3f3.png?v8\",\"white_flower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4ae.png?v8\",\"white_haired_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f468-1f9b3.png?v8\",\"white_haired_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9b3.png?v8\",\"white_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f90d.png?v8\",\"white_large_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/2b1c.png?v8\",\"white_medium_small_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25fd.png?v8\",\"white_medium_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25fb.png?v8\",\"white_small_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/25ab.png?v8\",\"white_square_button\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f533.png?v8\",\"wilted_flower\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f940.png?v8\",\"wind_chime\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f390.png?v8\",\"wind_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f32c.png?v8\",\"window\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa9f.png?v8\",\"wine_glass\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f377.png?v8\",\"wink\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f609.png?v8\",\"wolf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f43a.png?v8\",\"woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469.png?v8\",\"woman_artist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a8.png?v8\",\"woman_astronaut\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f680.png?v8\",\"woman_beard\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d4-2640.png?v8\",\"woman_cartwheeling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f938-2640.png?v8\",\"woman_cook\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f373.png?v8\",\"woman_dancing\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f483.png?v8\",\"woman_facepalming\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f926-2640.png?v8\",\"woman_factory_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3ed.png?v8\",\"woman_farmer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f33e.png?v8\",\"woman_feeding_baby\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f37c.png?v8\",\"woman_firefighter\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f692.png?v8\",\"woman_health_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2695.png?v8\",\"woman_in_manual_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bd.png?v8\",\"woman_in_motorized_wheelchair\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9bc.png?v8\",\"woman_in_tuxedo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f935-2640.png?v8\",\"woman_judge\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2696.png?v8\",\"woman_juggling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f939-2640.png?v8\",\"woman_mechanic\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f527.png?v8\",\"woman_office_worker\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bc.png?v8\",\"woman_pilot\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-2708.png?v8\",\"woman_playing_handball\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93e-2640.png?v8\",\"woman_playing_water_polo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93d-2640.png?v8\",\"woman_scientist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f52c.png?v8\",\"woman_shrugging\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f937-2640.png?v8\",\"woman_singer\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3a4.png?v8\",\"woman_student\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f393.png?v8\",\"woman_teacher\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f3eb.png?v8\",\"woman_technologist\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f4bb.png?v8\",\"woman_with_headscarf\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9d5.png?v8\",\"woman_with_probing_cane\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f469-1f9af.png?v8\",\"woman_with_turban\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f473-2640.png?v8\",\"woman_with_veil\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f470-2640.png?v8\",\"womans_clothes\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f45a.png?v8\",\"womans_hat\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f452.png?v8\",\"women_wrestling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93c-2640.png?v8\",\"womens\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f6ba.png?v8\",\"wood\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab5.png?v8\",\"woozy_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f974.png?v8\",\"world_map\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f5fa.png?v8\",\"worm\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fab1.png?v8\",\"worried\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f61f.png?v8\",\"wrench\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f527.png?v8\",\"wrestling\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f93c.png?v8\",\"writing_hand\":\"https://github.githubassets.com/images/icons/emoji/unicode/270d.png?v8\",\"x\":\"https://github.githubassets.com/images/icons/emoji/unicode/274c.png?v8\",\"yarn\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9f6.png?v8\",\"yawning_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f971.png?v8\",\"yellow_circle\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e1.png?v8\",\"yellow_heart\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f49b.png?v8\",\"yellow_square\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f7e8.png?v8\",\"yemen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1fe-1f1ea.png?v8\",\"yen\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4b4.png?v8\",\"yin_yang\":\"https://github.githubassets.com/images/icons/emoji/unicode/262f.png?v8\",\"yo_yo\":\"https://github.githubassets.com/images/icons/emoji/unicode/1fa80.png?v8\",\"yum\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f60b.png?v8\",\"zambia\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1f2.png?v8\",\"zany_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f92a.png?v8\",\"zap\":\"https://github.githubassets.com/images/icons/emoji/unicode/26a1.png?v8\",\"zebra\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f993.png?v8\",\"zero\":\"https://github.githubassets.com/images/icons/emoji/unicode/0030-20e3.png?v8\",\"zimbabwe\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ff-1f1fc.png?v8\",\"zipper_mouth_face\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f910.png?v8\",\"zombie\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9df.png?v8\",\"zombie_man\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8\",\"zombie_woman\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8\",\"zzz\":\"https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Add an authorized SSH key", - "scope": "enterpriseAdmin", - "id": "addAuthorizedSshKey", - "method": "POST", - "url": "{origin}/setup/api/settings/authorized-keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#add-an-authorized-ssh-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "authorized_key", - "description": "The public SSH key.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a GitHub license", - "scope": "enterpriseAdmin", - "id": "createEnterpriseServerLicense", - "method": "POST", - "url": "{origin}/setup/api/start", - "isDeprecated": false, - "deprecationDate": null, - "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#create-a-github-enterprise-server-license", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "license", - "description": "The content of your _.ghl_ license file.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "password", - "description": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "settings", - "description": "An optional JSON string containing the installation settings. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-settings).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 202, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Create a global webhook", - "scope": "enterpriseAdmin", - "id": "createGlobalWebhook", - "method": "POST", - "url": "/admin/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#create-a-global-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "Must be passed as \"web\".", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers) header.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "events", - "description": "The [events](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\",\"user\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create an impersonation OAuth token", - "scope": "enterpriseAdmin", - "id": "createImpersonationOAuthToken", - "method": "POST", - "url": "/admin/users/{username}/authorizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#create-an-impersonation-oauth-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "scopes", - "description": "A list of [scopes](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response when getting an existing impersonation OAuth token", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"expires_at\":\"2011-10-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}" - } - ] - }, - { - "code": 201, - "description": "Response when creating a new impersonation OAuth token", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"ghu_16C7e42F292c6912E7710c838347Ae178B4a\",\"token_last_eight\":\"Ae178B4a\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"expires_at\":\"2011-10-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create an organization", - "scope": "enterpriseAdmin", - "id": "createOrg", - "method": "POST", - "url": "/admin/organizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#create-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "login", - "description": "The organization's username.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "admin", - "description": "The login of the user who will manage this organization.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "profile_name", - "description": "The organization's display name.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "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\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "createPreReceiveEnvironment", - "method": "POST", - "url": "/admin/pre-receive-environments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#create-a-pre-receive-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "The new pre-receive environment's name.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "image_url", - "description": "URL from which to download a tarball of this environment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":null,\"message\":null}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a pre-receive hook", - "scope": "enterpriseAdmin", - "id": "createPreReceiveHook", - "method": "POST", - "url": "/admin/pre-receive-hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#create-a-pre-receive-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "The name of the hook.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script", - "description": "The script that the hook runs.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script_repository", - "description": "The GitHub repository where the script is kept.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script_repository.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "The pre-receive environment where the script is executed.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforcement", - "description": "The state of enforcement for this hook. default: `disabled`", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_downstream_configuration", - "description": "Whether enforcement can be overridden at the org or repo level. default: `false`", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a user", - "scope": "enterpriseAdmin", - "id": "createUser", - "method": "POST", - "url": "/admin/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#create-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "login", - "description": "The user's username.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "email", - "description": "**Required for built-in authentication.** The user's email\naddress. This parameter can be omitted when using CAS, LDAP, or SAML.\nFor more information, see \"[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.3/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a global webhook", - "scope": "enterpriseAdmin", - "id": "deleteGlobalWebhook", - "method": "DELETE", - "url": "/admin/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#delete-a-global-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an impersonation OAuth token", - "scope": "enterpriseAdmin", - "id": "deleteImpersonationOAuthToken", - "method": "DELETE", - "url": "/admin/users/{username}/authorizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#delete-an-impersonation-oauth-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a personal access token", - "scope": "enterpriseAdmin", - "id": "deletePersonalAccessToken", - "method": "DELETE", - "url": "/admin/tokens/{token_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#delete-a-personal-access-token", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "token_id", - "description": "The unique identifier of the token.", - "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 a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "deletePreReceiveEnvironment", - "method": "DELETE", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Cannot delete environment that has hooks_\n* _Cannot delete environment when download is in progress_", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#delete-a-pre-receive-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.", - "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": 422, - "description": "Client Errors", - "examples": [ - { - "data": "{\"message\":\"Validation Failed\",\"errors\":[{\"resource\":\"PreReceiveEnvironment\",\"code\":\"custom\",\"message\":\"Cannot modify or delete the default environment\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a pre-receive hook", - "scope": "enterpriseAdmin", - "id": "deletePreReceiveHook", - "method": "DELETE", - "url": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#delete-a-pre-receive-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "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 a public key", - "scope": "enterpriseAdmin", - "id": "deletePublicKey", - "method": "DELETE", - "url": "/admin/keys/{key_ids}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#delete-a-public-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_ids", - "description": "The unique identifier of the key.", - "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": "Delete a user", - "scope": "enterpriseAdmin", - "id": "deleteUser", - "method": "DELETE", - "url": "/admin/users/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#delete-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Demote a site administrator", - "scope": "enterpriseAdmin", - "id": "demoteSiteAdministrator", - "method": "DELETE", - "url": "/users/{username}/site_admin", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can demote any user account except your own.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#demote-a-site-administrator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Disable a selected organization for GitHub Actions in an enterprise", - "scope": "enterpriseAdmin", - "id": "disableSelectedOrganizationGithubActionsEnterprise", - "method": "DELETE", - "url": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#disable-a-selected-organization-for-github-actions-in-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "org_id", - "description": "The unique identifier of the organization.", - "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": "Enable or disable maintenance mode", - "scope": "enterpriseAdmin", - "id": "enableOrDisableMaintenanceMode", - "method": "POST", - "url": "{origin}/setup/api/maintenance", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#enable-or-disable-maintenance-mode", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "maintenance", - "description": "A JSON string with the attributes `enabled` and `when`.\n\nThe possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"status\":\"scheduled\",\"scheduled_time\":\"Tuesday, January 22 at 15:34 -0800\",\"connection_services\":[{\"name\":\"git operations\",\"number\":0},{\"name\":\"mysql queries\",\"number\":233},{\"name\":\"aqueduct jobs\",\"number\":34},{\"name\":\"resque jobs\",\"number\":54}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Enable a selected organization for GitHub Actions in an enterprise", - "scope": "enterpriseAdmin", - "id": "enableSelectedOrganizationGithubActionsEnterprise", - "method": "PUT", - "url": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#enable-a-selected-organization-for-github-actions-in-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "org_id", - "description": "The unique identifier of the organization.", - "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": "Get all authorized SSH keys", - "scope": "enterpriseAdmin", - "id": "getAllAuthorizedSshKeys", - "method": "GET", - "url": "{origin}/setup/api/settings/authorized-keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-all-authorized-ssh-keys", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get all statistics", - "scope": "enterpriseAdmin", - "id": "getAllStats", - "method": "GET", - "url": "/enterprise/stats/all", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"repos\":{\"total_repos\":212,\"root_repos\":194,\"fork_repos\":18,\"org_repos\":51,\"total_pushes\":3082,\"total_wikis\":15},\"hooks\":{\"total_hooks\":27,\"active_hooks\":23,\"inactive_hooks\":4},\"pages\":{\"total_pages\":36},\"orgs\":{\"total_orgs\":33,\"disabled_orgs\":0,\"total_teams\":60,\"total_team_members\":314},\"users\":{\"total_users\":254,\"admin_users\":45,\"suspended_users\":21},\"pulls\":{\"total_pulls\":86,\"merged_pulls\":60,\"mergeable_pulls\":21,\"unmergeable_pulls\":3},\"issues\":{\"total_issues\":179,\"open_issues\":83,\"closed_issues\":96},\"milestones\":{\"total_milestones\":7,\"open_milestones\":6,\"closed_milestones\":1},\"gists\":{\"total_gists\":178,\"private_gists\":151,\"public_gists\":25},\"comments\":{\"total_commit_comments\":6,\"total_gist_comments\":28,\"total_issue_comments\":366,\"total_pull_request_comments\":30}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get allowed actions for an enterprise", - "scope": "enterpriseAdmin", - "id": "getAllowedActionsEnterprise", - "method": "GET", - "url": "/enterprises/{enterprise}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-allowed-actions-for-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"github_owned_allowed\":true,\"verified_allowed\":false,\"patterns_allowed\":[\"monalisa/octocat@*\",\"docker/*\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the global announcement banner", - "scope": "enterpriseAdmin", - "id": "getAnnouncement", - "method": "GET", - "url": "/enterprise/announcement", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the current message and expiration date of the global announcement banner in your enterprise.", - "documentationUrl": "", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"announcement\":\"Very **important** announcement about _nothing_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get comment statistics", - "scope": "enterpriseAdmin", - "id": "getCommentStats", - "method": "GET", - "url": "/enterprise/stats/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-comment-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get the configuration status", - "scope": "enterpriseAdmin", - "id": "getConfigurationStatus", - "method": "GET", - "url": "{origin}/setup/api/configcheck", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status | Description |\n| ------------- | --------------------------------- |\n| `PENDING` | The job has not started yet |\n| `CONFIGURING` | The job is running |\n| `DONE` | The job has finished correctly |\n| `FAILED` | The job has finished unexpectedly |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-the-configuration-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"status\":\"running\",\"progress\":[{\"status\":\"DONE\",\"key\":\"Appliance core components\"},{\"status\":\"DONE\",\"key\":\"GitHub utilities\"},{\"status\":\"DONE\",\"key\":\"GitHub applications\"},{\"status\":\"CONFIGURING\",\"key\":\"GitHub services\"},{\"status\":\"PENDING\",\"key\":\"Reloading appliance services\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the download status for a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "getDownloadStatusForPreReceiveEnvironment", - "method": "GET", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - "isDeprecated": false, - "deprecationDate": null, - "description": "In addition to seeing the download status at the \"[Get a pre-receive environment](#get-a-pre-receive-environment)\" endpoint, there is also this separate endpoint for just the download status.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-the-download-status-for-a-pre-receive-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get gist statistics", - "scope": "enterpriseAdmin", - "id": "getGistStats", - "method": "GET", - "url": "/enterprise/stats/gists", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-gist-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get GitHub Actions permissions for an enterprise", - "scope": "enterpriseAdmin", - "id": "getGithubActionsPermissionsEnterprise", - "method": "GET", - "url": "/enterprises/{enterprise}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#get-github-actions-permissions-for-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"enabled_organizations\":\"all\",\"allowed_actions\":\"selected\",\"selected_actions_url\":\"https://api.github.com/enterprises/2/actions/permissions/selected-actions\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a global webhook", - "scope": "enterpriseAdmin", - "id": "getGlobalWebhook", - "method": "GET", - "url": "/admin/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-a-global-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\",\"user\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get hooks statistics", - "scope": "enterpriseAdmin", - "id": "getHooksStats", - "method": "GET", - "url": "/enterprise/stats/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-hooks-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get issue statistics", - "scope": "enterpriseAdmin", - "id": "getIssueStats", - "method": "GET", - "url": "/enterprise/stats/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-issues-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get license information", - "scope": "enterpriseAdmin", - "id": "getLicenseInformation", - "method": "GET", - "url": "/enterprise/settings/license", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-license-information", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"seats\":1400,\"seats_used\":1316,\"seats_available\":84,\"kind\":\"standard\",\"days_until_expiration\":365,\"expire_at\":\"2016/02/06 12:41:52 -0600\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the maintenance status", - "scope": "enterpriseAdmin", - "id": "getMaintenanceStatus", - "method": "GET", - "url": "{origin}/setup/api/maintenance", - "isDeprecated": false, - "deprecationDate": null, - "description": "Check your installation's maintenance status:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-the-maintenance-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"status\":\"scheduled\",\"scheduled_time\":\"Tuesday, January 22 at 15:34 -0800\",\"connection_services\":[{\"name\":\"git operations\",\"number\":0},{\"name\":\"mysql queries\",\"number\":233},{\"name\":\"aqueduct jobs\",\"number\":34},{\"name\":\"resque jobs\",\"number\":54}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get milestone statistics", - "scope": "enterpriseAdmin", - "id": "getMilestoneStats", - "method": "GET", - "url": "/enterprise/stats/milestones", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-milestone-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get organization statistics", - "scope": "enterpriseAdmin", - "id": "getOrgStats", - "method": "GET", - "url": "/enterprise/stats/orgs", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-organization-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get pages statistics", - "scope": "enterpriseAdmin", - "id": "getPagesStats", - "method": "GET", - "url": "/enterprise/stats/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-pages-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "getPreReceiveEnvironment", - "method": "GET", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-a-pre-receive-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.", - "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\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":null,\"message\":null}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a pre-receive hook", - "scope": "enterpriseAdmin", - "id": "getPreReceiveHook", - "method": "GET", - "url": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-a-pre-receive-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "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\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a pre-receive hook for an organization", - "scope": "enterpriseAdmin", - "id": "getPreReceiveHookForOrg", - "method": "GET", - "url": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "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\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\"allow_downstream_configuration\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a pre-receive hook for a repository", - "scope": "enterpriseAdmin", - "id": "getPreReceiveHookForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-a-pre-receive-hook-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "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\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get pull request statistics", - "scope": "enterpriseAdmin", - "id": "getPullRequestStats", - "method": "GET", - "url": "/enterprise/stats/pulls", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-pull-requests-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get repository statistics", - "scope": "enterpriseAdmin", - "id": "getRepoStats", - "method": "GET", - "url": "/enterprise/stats/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-repository-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Get settings", - "scope": "enterpriseAdmin", - "id": "getSettings", - "method": "GET", - "url": "{origin}/setup/api/settings", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#set-settings).\n\n**Note:** You cannot retrieve the management console password with the Enterprise administration API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-settings", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"enterprise\":{\"private_mode\":false,\"public_pages\":false,\"subdomain_isolation\":true,\"signup_enabled\":false,\"github_hostname\":\"ghe.local\",\"identicons_host\":\"dotcom\",\"http_proxy\":null,\"auth_mode\":\"default\",\"expire_sessions\":false,\"admin_password\":null,\"configuration_id\":1401777404,\"configuration_run_count\":4,\"avatar\":{\"enabled\":false,\"uri\":\"\"},\"customer\":{\"name\":\"GitHub\",\"email\":\"stannis@themannis.biz\",\"uuid\":\"af6cac80-e4e1-012e-d822-1231380e52e9\",\"secret_key_data\":\"-----BEGIN PGP PRIVATE KEY BLOCK-----\\nVersion: GnuPG v1.4.10 (GNU/Linux)\\n\\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\\n-----END PGP PRIVATE KEY BLOCK-----\\n\",\"public_key_data\":\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v1.4.10 (GNU/Linux)\\n\\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\\n-----END PGP PUBLIC KEY BLOCK-----\\n\"},\"license\":{\"seats\":0,\"evaluation\":false,\"perpetual\":false,\"unlimited_seating\":true,\"support_key\":\"ssh-rsa AAAAB3N....\",\"ssh_allowed\":true,\"cluster_support\":false,\"expire_at\":\"2016-04-27T00:00:00-07:00\"},\"github_ssl\":{\"enabled\":false,\"cert\":null,\"key\":null},\"ldap\":{\"host\":null,\"port\":0,\"base\":[],\"uid\":null,\"bind_dn\":null,\"password\":null,\"method\":\"Plain\",\"search_strategy\":\"detect\",\"user_groups\":[],\"admin_group\":null,\"virtual_attribute_enabled\":false,\"recursive_group_search\":false,\"posix_support\":true,\"user_sync_emails\":false,\"user_sync_keys\":false,\"user_sync_interval\":4,\"team_sync_interval\":4,\"sync_enabled\":false,\"reconciliation\":{\"user\":null,\"org\":null},\"profile\":{\"uid\":\"uid\",\"name\":null,\"mail\":null,\"key\":null}},\"cas\":{\"url\":null},\"saml\":{\"sso_url\":null,\"certificate\":null,\"certificate_path\":null,\"issuer\":null,\"idp_initiated_sso\":false,\"disable_admin_demote\":false},\"github_oauth\":{\"client_id\":\"12313412\",\"client_secret\":\"kj123131132\",\"organization_name\":\"Homestar Runners\",\"organization_team\":\"homestarrunners/characters\"},\"smtp\":{\"enabled\":true,\"address\":\"smtp.example.com\",\"authentication\":\"plain\",\"port\":\"1234\",\"domain\":\"blah\",\"username\":\"foo\",\"user_name\":\"mr_foo\",\"enable_starttls_auto\":true,\"password\":\"bar\",\"discard-to-noreply-address\":true,\"support_address\":\"enterprise@github.com\",\"support_address_type\":\"email\",\"noreply_address\":\"noreply@github.com\"},\"ntp\":{\"primary_server\":\"0.pool.ntp.org\",\"secondary_server\":\"1.pool.ntp.org\"},\"timezone\":null,\"snmp\":{\"enabled\":false,\"community\":\"\"},\"syslog\":{\"enabled\":false,\"server\":null,\"protocol_name\":\"udp\"},\"assets\":null,\"pages\":{\"enabled\":true},\"collectd\":{\"enabled\":false,\"server\":null,\"port\":0,\"encryption\":null,\"username\":null,\"password\":null},\"mapping\":{\"enabled\":true,\"tileserver\":null,\"basemap\":\"company.map-qsz2zrvs\",\"token\":null},\"load_balancer\":null},\"run_list\":[\"recipe[enterprise-configure]\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get users statistics", - "scope": "enterpriseAdmin", - "id": "getUserStats", - "method": "GET", - "url": "/enterprise/stats/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-users-statistics", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "List global webhooks", - "scope": "enterpriseAdmin", - "id": "listGlobalWebhooks", - "method": "GET", - "url": "/admin/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#list-global-webhooks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\",\"user\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List personal access tokens", - "scope": "enterpriseAdmin", - "id": "listPersonalAccessTokens", - "method": "GET", - "url": "/admin/tokens", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists personal access tokens for all users, including admin users.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#list-personal-access-tokens", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":2,\"url\":\"https://enterprise.octocat.com/api/v3/authorizations/2\",\"app\":{\"name\":\"My personal access token\",\"url\":\"https://docs.github.com/enterprise/rest/reference/enterprise-admin#list-personal-access-tokens\",\"client_id\":\"00000000000000000000\"},\"token\":\"ghp_16C7e42F292c6912E7710c838347Ae178B4a\",\"hashed_token\":\"23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45\",\"token_last_eight\":\"Ae178B4a\",\"note\":\"My personal access token\",\"note_url\":null,\"created_at\":\"2019-04-24T21:49:02Z\",\"updated_at\":\"2019-04-24T21:49:02Z\",\"scopes\":[\"admin:business\",\"admin:gpg_key\",\"admin:org\",\"admin:org_hook\",\"admin:pre_receive_hook\",\"admin:public_key\",\"admin:repo_hook\",\"delete_repo\",\"gist\",\"notifications\",\"repo\",\"user\",\"write:discussion\"],\"fingerprint\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pre-receive environments", - "scope": "enterpriseAdmin", - "id": "listPreReceiveEnvironments", - "method": "GET", - "url": "/admin/pre-receive-environments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#list-pre-receive-environments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"name\":\"Default\",\"image_url\":\"githubenterprise://internal\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/1\",\"default_environment\":true,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":14,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pre-receive hooks", - "scope": "enterpriseAdmin", - "id": "listPreReceiveHooks", - "method": "GET", - "url": "/admin/pre-receive-hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#list-pre-receive-hooks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pre-receive hooks for an organization", - "scope": "enterpriseAdmin", - "id": "listPreReceiveHooksForOrg", - "method": "GET", - "url": "/orgs/{org}/pre-receive-hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#list-pre-receive-hooks-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The sort order for the response collection.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\"allow_downstream_configuration\":true}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pre-receive hooks for a repository", - "scope": "enterpriseAdmin", - "id": "listPreReceiveHooksForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/pre-receive-hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#list-pre-receive-hooks-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public keys", - "scope": "enterpriseAdmin", - "id": "listPublicKeys", - "method": "GET", - "url": "/admin/keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#list-public-keys", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "accessed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show public keys accessed after the given time.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false,\"last_used\":\"2020-06-11T22:31:57Z\",\"user_id\":1,\"repository_id\":2},{\"key\":\"9Og8iYjAyymI9LvABpJerYrMxURPc8r+dB7TJyvv1234\",\"id\":3,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false,\"last_used\":\"2020-06-11T22:31:57Z\",\"user_id\":1,\"repository_id\":2}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List selected organizations enabled for GitHub Actions in an enterprise", - "scope": "enterpriseAdmin", - "id": "listSelectedOrganizationsEnabledGithubActionsEnterprise", - "method": "GET", - "url": "/enterprises/{enterprise}/actions/permissions/organizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"organizations\":[{\"login\":\"octocat\",\"id\":161335,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"url\":\"https://api.github.com/orgs/octo-org\",\"repos_url\":\"https://api.github.com/orgs/octo-org/repos\",\"events_url\":\"https://api.github.com/orgs/octo-org/events\",\"hooks_url\":\"https://api.github.com/orgs/octo-org/hooks\",\"issues_url\":\"https://api.github.com/orgs/octo-org/issues\",\"members_url\":\"https://api.github.com/orgs/octo-org/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/octo-org/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Ping a global webhook", - "scope": "enterpriseAdmin", - "id": "pingGlobalWebhook", - "method": "POST", - "url": "/admin/hooks/{hook_id}/pings", - "isDeprecated": false, - "deprecationDate": null, - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.3/webhooks/#ping-event) to be sent to the webhook.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#ping-a-global-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Promote a user to be a site administrator", - "scope": "enterpriseAdmin", - "id": "promoteUserToBeSiteAdministrator", - "method": "PUT", - "url": "/users/{username}/site_admin", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#promote-a-user-to-be-a-site-administrator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove the global announcement banner", - "scope": "enterpriseAdmin", - "id": "removeAnnouncement", - "method": "DELETE", - "url": "/enterprise/announcement", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes the global announcement banner in your enterprise.", - "documentationUrl": "", - "previews": [], - "headers": [], - "parameters": [], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove an authorized SSH key", - "scope": "enterpriseAdmin", - "id": "removeAuthorizedSshKey", - "method": "DELETE", - "url": "{origin}/setup/api/settings/authorized-keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#remove-an-authorized-ssh-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "authorized_key", - "description": "The public SSH key.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove pre-receive hook enforcement for an organization", - "scope": "enterpriseAdmin", - "id": "removePreReceiveHookEnforcementForOrg", - "method": "DELETE", - "url": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes any overrides for this hook at the org level for this org.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "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\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\"allow_downstream_configuration\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove pre-receive hook enforcement for a repository", - "scope": "enterpriseAdmin", - "id": "removePreReceiveHookEnforcementForRepo", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes any overridden enforcement on this repository for the specified hook.\n\nResponds with effective values inherited from owner and/or global level.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#remove-pre-receive-hook-enforcement-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Responds with effective values inherited from owner and/or global level.", - "examples": [ - { - "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set allowed actions for an enterprise", - "scope": "enterpriseAdmin", - "id": "setAllowedActionsEnterprise", - "method": "PUT", - "url": "/enterprises/{enterprise}/actions/permissions/selected-actions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-allowed-actions-for-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "github_owned_allowed", - "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "patterns_allowed", - "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", - "in": "BODY", - "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": "Set the global announcement banner", - "scope": "enterpriseAdmin", - "id": "setAnnouncement", - "method": "PATCH", - "url": "/enterprise/announcement", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the message and expiration time for the global announcement banner in your enterprise.", - "documentationUrl": "", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "announcement", - "description": "The announcement text in GitHub Flavored Markdown. For more information about GitHub Flavored Markdown, see \"[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.3/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax).\"", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "expires_at", - "description": "The time at which the announcement expires. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. To set an announcement that never expires, omit this parameter, set it to `null`, or set it to an empty string.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"announcement\":\"Very **important** announcement about _nothing_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set GitHub Actions permissions for an enterprise", - "scope": "enterpriseAdmin", - "id": "setGithubActionsPermissionsEnterprise", - "method": "PUT", - "url": "/enterprises/{enterprise}/actions/permissions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-github-actions-permissions-for-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enabled_organizations", - "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["all", "none", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allowed_actions", - "description": "The permissions policy that controls the actions that are allowed to run.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "local_only", "selected"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Set selected organizations enabled for GitHub Actions in an enterprise", - "scope": "enterpriseAdmin", - "id": "setSelectedOrganizationsEnabledGithubActionsEnterprise", - "method": "PUT", - "url": "/enterprises/{enterprise}/actions/permissions/organizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/actions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "selected_organization_ids", - "description": "List of organization IDs to enable for GitHub Actions.", - "in": "BODY", - "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 settings", - "scope": "enterpriseAdmin", - "id": "setSettings", - "method": "PUT", - "url": "{origin}/setup/api/settings", - "isDeprecated": false, - "deprecationDate": null, - "description": "Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-settings).\n\n**Notes:**\n\n- The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).\n- You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see \"[Command-line utilities](https://docs.github.com/enterprise-server@3.3/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#set-settings", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "settings", - "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-settings).", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Start a configuration process", - "scope": "enterpriseAdmin", - "id": "startConfigurationProcess", - "method": "POST", - "url": "{origin}/setup/api/configure", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#start-a-configuration-process", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 202, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Start a pre-receive environment download", - "scope": "enterpriseAdmin", - "id": "startPreReceiveEnvironmentDownload", - "method": "POST", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - "isDeprecated": false, - "deprecationDate": null, - "description": "Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment.\n\nIf a download cannot be triggered, you will receive a `422 Unprocessable Entity` response.\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Can not start a new download when a download is in progress_", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#start-a-pre-receive-environment-download", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":null,\"message\":null}" - } - ] - }, - { - "code": 422, - "description": "Client Errors", - "examples": [ - { - "data": "{\"message\":\"Validation Failed\",\"errors\":[{\"resource\":\"PreReceiveEnvironment\",\"code\":\"custom\",\"message\":\"Can not start a new download when a download is in progress\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Suspend a user", - "scope": "enterpriseAdmin", - "id": "suspendUser", - "method": "PUT", - "url": "/users/{username}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.3/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#suspend-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reason", - "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.3/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Sync LDAP mapping for a team", - "scope": "enterpriseAdmin", - "id": "syncLdapMappingForTeam", - "method": "POST", - "url": "/admin/ldap/teams/{team_id}/sync", - "isDeprecated": false, - "deprecationDate": null, - "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#sync-ldap-mapping-for-a-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [{ "data": "{\"status\":\"queued\"}" }] - } - ], - "renamed": null - }, - { - "name": "Sync LDAP mapping for a user", - "scope": "enterpriseAdmin", - "id": "syncLdapMappingForUser", - "method": "POST", - "url": "/admin/ldap/users/{username}/sync", - "isDeprecated": false, - "deprecationDate": null, - "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#sync-ldap-mapping-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [{ "data": "{\"status\":\"queued\"}" }] - } - ], - "renamed": null - }, - { - "name": "Unsuspend a user", - "scope": "enterpriseAdmin", - "id": "unsuspendUser", - "method": "DELETE", - "url": "/users/{username}/suspended", - "isDeprecated": false, - "deprecationDate": null, - "description": "If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.3/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#unsuspend-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reason", - "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://docs.github.com/enterprise-server@3.3/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Update a global webhook", - "scope": "enterpriseAdmin", - "id": "updateGlobalWebhook", - "method": "PATCH", - "url": "/admin/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#update-a-global-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers) header.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "events", - "description": "The [events](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"form\",\"insecure_ssl\":\"0\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update LDAP mapping for a team", - "scope": "enterpriseAdmin", - "id": "updateLdapMappingForTeam", - "method": "PATCH", - "url": "/admin/ldap/teams/{team_id}/mapping", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.3/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#create-a-team) endpoint to create a team with LDAP mapping.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ldap_dn", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ldap_dn\":\"cn=Enterprise Ops,ou=teams,dc=github,dc=com\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update LDAP mapping for a user", - "scope": "enterpriseAdmin", - "id": "updateLdapMappingForUser", - "method": "PATCH", - "url": "/admin/ldap/users/{username}/mapping", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#update-ldap-mapping-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ldap_dn", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\",\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"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\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"twitter_username\":\"monatheoctocat\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"private_gists\":81,\"total_private_repos\":100,\"owned_private_repos\":100,\"disk_usage\":10000,\"collaborators\":8,\"two_factor_authentication\":true,\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"collaborators\":0}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update an organization name", - "scope": "enterpriseAdmin", - "id": "updateOrgName", - "method": "PATCH", - "url": "/admin/organizations/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#update-an-organization-name", - "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": "login", - "description": "The organization's new name.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"message\":\"Job queued to rename organization. It may take a few minutes to complete.\",\"url\":\"https:///api/v3/organizations/1\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a pre-receive environment", - "scope": "enterpriseAdmin", - "id": "updatePreReceiveEnvironment", - "method": "PATCH", - "url": "/admin/pre-receive-environments/{pre_receive_environment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#update-a-pre-receive-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_environment_id", - "description": "The unique identifier of the pre-receive environment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "This pre-receive environment's new name.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "image_url", - "description": "URL from which to download a tarball of this environment.", - "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\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}}" - } - ] - }, - { - "code": 422, - "description": "Client Errors", - "examples": [ - { - "data": "{\"message\":\"Validation Failed\",\"errors\":[{\"resource\":\"PreReceiveEnvironment\",\"code\":\"custom\",\"message\":\"Cannot modify or delete the default environment\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a pre-receive hook", - "scope": "enterpriseAdmin", - "id": "updatePreReceiveHook", - "method": "PATCH", - "url": "/admin/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#update-a-pre-receive-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "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 hook.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script", - "description": "The script that the hook runs.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script_repository", - "description": "The GitHub repository where the script is kept.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "script_repository.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "The pre-receive environment where the script is executed.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforcement", - "description": "The state of enforcement for this hook.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_downstream_configuration", - "description": "Whether enforcement can be overridden at the org or repo level.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":1,\"name\":\"Default\",\"image_url\":\"githubenterprise://internal\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/1\",\"default_environment\":true,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update pre-receive hook enforcement for an organization", - "scope": "enterpriseAdmin", - "id": "updatePreReceiveHookEnforcementForOrg", - "method": "PATCH", - "url": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforcement", - "description": "The state of enforcement for the hook on this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_downstream_configuration", - "description": "Whether repositories can override enforcement.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"enabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\",\"allow_downstream_configuration\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update pre-receive hook enforcement for a repository", - "scope": "enterpriseAdmin", - "id": "updatePreReceiveHookEnforcementForRepo", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#update-pre-receive-hook-enforcement-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pre_receive_hook_id", - "description": "The unique identifier of the pre-receive hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforcement", - "description": "The state of enforcement for the hook on this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["enabled", "disabled", "testing"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"enabled\",\"configuration_url\":\"https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update the username for a user", - "scope": "enterpriseAdmin", - "id": "updateUsernameForUser", - "method": "PATCH", - "url": "/admin/users/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#update-the-username-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "login", - "description": "The user's new username.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"message\":\"Job queued to rename user. It may take a few minutes to complete.\",\"url\":\"https://api.github.com/user/1\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Upgrade a license", - "scope": "enterpriseAdmin", - "id": "upgradeLicense", - "method": "POST", - "url": "{origin}/setup/api/upgrade", - "isDeprecated": false, - "deprecationDate": null, - "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#upgrade-a-license", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "license", - "description": "The content of your new _.ghl_ license file.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": null, - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 202, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Check if a gist is starred", - "scope": "gists", - "id": "checkIsStarred", - "method": "GET", - "url": "/gists/{gist_id}/star", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#check-if-a-gist-is-starred", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if gist is starred", - "examples": null - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if gist is not starred", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a gist", - "scope": "gists", - "id": "create", - "method": "POST", - "url": "/gists", - "isDeprecated": false, - "deprecationDate": null, - "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#create-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "description", - "description": "Description of the gist", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files", - "description": "Names and content for the files that make up the gist", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*.content", - "description": "Content of the file", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "public", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a gist comment", - "scope": "gists", - "id": "createComment", - "method": "POST", - "url": "/gists/{gist_id}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#create-a-gist-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The comment text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"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},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a gist", - "scope": "gists", - "id": "delete", - "method": "DELETE", - "url": "/gists/{gist_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#delete-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "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 }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a gist comment", - "scope": "gists", - "id": "deleteComment", - "method": "DELETE", - "url": "/gists/{gist_id}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#delete-a-gist-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Fork a gist", - "scope": "gists", - "id": "fork", - "method": "POST", - "url": "/gists/{gist_id}/forks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#fork-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a gist", - "scope": "gists", - "id": "get", - "method": "GET", - "url": "/gists/{gist_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#get-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden Gist", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a gist comment", - "scope": "gists", - "id": "getComment", - "method": "GET", - "url": "/gists/{gist_id}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#get-a-gist-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"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},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden Gist", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a gist revision", - "scope": "gists", - "id": "getRevision", - "method": "GET", - "url": "/gists/{gist_id}/{sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#get-a-gist-revision", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" - } - ] - }, - { "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": "List gists for the authenticated user", - "scope": "gists", - "id": "list", - "method": "GET", - "url": "/gists", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#list-gists-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List gist comments", - "scope": "gists", - "id": "listComments", - "method": "GET", - "url": "/gists/{gist_id}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#list-gist-comments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"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},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List gist commits", - "scope": "gists", - "id": "listCommits", - "method": "GET", - "url": "/gists/{gist_id}/commits", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#list-gist-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"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},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List gists for a user", - "scope": "gists", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/gists", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists public gists for the specified user:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#list-gists-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List gist forks", - "scope": "gists", - "id": "listForks", - "method": "GET", - "url": "/gists/{gist_id}/forks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#list-gist-forks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":1,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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}}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List public gists", - "scope": "gists", - "id": "listPublic", - "method": "GET", - "url": "/gists/public", - "isDeprecated": false, - "deprecationDate": null, - "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/enterprise-server@3.3/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#list-public-gists", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List starred gists", - "scope": "gists", - "id": "listStarred", - "method": "GET", - "url": "/gists/starred", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the authenticated user's starred gists:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#list-starred-gists", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"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},\"truncated\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Star a gist", - "scope": "gists", - "id": "star", - "method": "PUT", - "url": "/gists/{gist_id}/star", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#star-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "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 }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unstar a gist", - "scope": "gists", - "id": "unstar", - "method": "DELETE", - "url": "/gists/{gist_id}/star", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#unstar-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "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 }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a gist", - "scope": "gists", - "id": "update", - "method": "PATCH", - "url": "/gists/{gist_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists/#update-a-gist", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "Description of the gist", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files", - "description": "Names of files to be updated", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*.content", - "description": "The new content of the file", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.*.filename", - "description": "The new filename for the file", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a gist comment", - "scope": "gists", - "id": "updateComment", - "method": "PATCH", - "url": "/gists/{gist_id}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gists#update-a-gist-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "The unique identifier of the gist.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The comment text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"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},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a blob", - "scope": "git", - "id": "createBlob", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/blobs", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#create-a-blob", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The new blob's content.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "encoding", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a commit", - "scope": "git", - "id": "createCommit", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/commits", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#create-a-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The commit message", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree", - "description": "The SHA of the tree object this commit points to", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parents", - "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author", - "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.email", - "description": "The email of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.date", - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer", - "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.email", - "description": "The email of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.date", - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "signature", - "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132\",\"sha\":\"827efc6d56897b048c772eb4087f854f46256132\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0\",\"sha\":\"7d1b31e74ee336d15cbd21741bc88a537ed063a0\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7d1b31e74ee336d15cbd21741bc88a537ed063a0\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null},\"html_url\":\"https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd\"}" - } - ] - }, - { "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 a reference", - "scope": "git", - "id": "createRef", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/refs", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#create-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "The SHA1 value for this reference.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a tag object", - "scope": "git", - "id": "createTag", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/tags", - "isDeprecated": false, - "deprecationDate": null, - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://docs.github.com/enterprise-server@3.3/rest/reference/git#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://docs.github.com/enterprise-server@3.3/rest/reference/git#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#create-a-tag-object", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag", - "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The tag message.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "object", - "description": "The SHA of the git object this is tagging.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "type", - "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["commit", "tree", "blob"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger", - "description": "An object with information about the individual creating the tag.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger.name", - "description": "The name of the author of the tag", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger.email", - "description": "The email of the author of the tag", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger.date", - "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"node_id\":\"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\"tag\":\"v0.0.1\",\"sha\":\"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"message\":\"initial version\",\"tagger\":{\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\",\"date\":\"2014-11-07T22:01:45Z\"},\"object\":{\"type\":\"commit\",\"sha\":\"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a tree", - "scope": "git", - "id": "createTree", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/trees", - "isDeprecated": false, - "deprecationDate": null, - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://docs.github.com/enterprise-server@3.3/rest/reference/git#create-a-commit)\" and \"[Update a reference](https://docs.github.com/enterprise-server@3.3/rest/reference/git#update-a-reference).\"\n\nReturns an error if you try to delete a file that does not exist.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#create-a-tree", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree", - "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", - "in": "BODY", - "type": "object[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].path", - "description": "The file referenced in the tree.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].mode", - "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["100644", "100755", "040000", "160000", "120000"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].type", - "description": "Either `blob`, `tree`, or `commit`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["blob", "tree", "commit"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].sha", - "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree[].content", - "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base_tree", - "description": "The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on.\nIf not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit.\n", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"sha\":\"cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\"tree\":[{\"path\":\"file.rb\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":132,\"sha\":\"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"}],\"truncated\":true}" - } - ] - }, - { "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": "Delete a reference", - "scope": "git", - "id": "deleteRef", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/git/refs/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#delete-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a blob", - "scope": "git", - "id": "getBlob", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/blobs/{file_sha}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#get-a-blob", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "file_sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content\":\"Q29udGVudCBvZiB0aGUgYmxvYg==\",\"encoding\":\"base64\",\"url\":\"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"size\":19,\"node_id\":\"Q29udGVudCBvZiB0aGUgYmxvYg==\"}" - } - ] - }, - { "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": "Get a commit", - "scope": "git", - "id": "getCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/commits/{commit_sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in the table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#get-a-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit.", - "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": "{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"added readme, because im a good github citizen\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7638417db6d59f3c431d3e1f261cc637155684cd\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a reference", - "scope": "git", - "id": "getRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/ref/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.3/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#get-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a tag", - "scope": "git", - "id": "getTag", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/tags/{tag_sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#get-a-tag", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag_sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"node_id\":\"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\"tag\":\"v0.0.1\",\"sha\":\"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"message\":\"initial version\",\"tagger\":{\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\",\"date\":\"2014-11-07T22:01:45Z\"},\"object\":{\"type\":\"commit\",\"sha\":\"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a tree", - "scope": "git", - "id": "getTree", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/trees/{tree_sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#get-a-tree", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree_sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "recursive", - "description": "Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in `:tree_sha`. For example, setting `recursive` to any of the following will enable returning objects or subtrees: `0`, `1`, `\"true\"`, and `\"false\"`. Omit this parameter to prevent recursively returning objects or subtrees.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"sha\":\"9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\"tree\":[{\"path\":\"file.rb\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":30,\"sha\":\"44b4fc6d56897b048c772eb4087f854f46256132\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132\"},{\"path\":\"subdir\",\"mode\":\"040000\",\"type\":\"tree\",\"sha\":\"f484d249c660418515fb01c2b9662073663c242e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e\"},{\"path\":\"exec_file\",\"mode\":\"100755\",\"type\":\"blob\",\"size\":75,\"sha\":\"45b983be36b73c0788dc9cbcb76cbb80fc7bb057\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057\"}],\"truncated\":false}" - }, - { - "data": "{\"sha\":\"fc6274d15fa3ae2ab983129fb037999f264ba9a7\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/fc6274d15fa3ae2ab983129fb037999f264ba9a7\",\"tree\":[{\"path\":\"subdir/file.txt\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":132,\"sha\":\"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"}],\"truncated\":false}" - } - ] - }, - { "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 matching references", - "scope": "git", - "id": "listMatchingRefs", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/matching-refs/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://docs.github.com/enterprise-server@3.3/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#list-matching-references", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"ref\":\"refs/heads/feature-a\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}},{\"ref\":\"refs/heads/feature-b\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b\",\"object\":{\"type\":\"commit\",\"sha\":\"612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\"}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a reference", - "scope": "git", - "id": "updateRef", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/git/refs/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/git#update-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the fully qualified reference to update. For example, `refs/heads/master`. If the value doesn't start with `refs` and have at least two slashes, it will be rejected.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "The SHA1 value to set this reference to", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "force", - "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get all gitignore templates", - "scope": "gitignore", - "id": "getAllTemplates", - "method": "GET", - "url": "/gitignore/templates", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-a-repository-for-the-authenticated-user).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gitignore#get-all-gitignore-templates", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[\"Actionscript\",\"Android\",\"AppceleratorTitanium\",\"Autotools\",\"Bancha\",\"C\",\"C++\"]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a gitignore template", - "scope": "gitignore", - "id": "getTemplate", - "method": "GET", - "url": "/gitignore/templates/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "The API also allows fetching the source of a single template.\nUse the raw [media type](https://docs.github.com/enterprise-server@3.3/rest/overview/media-types/) to get the raw contents.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/gitignore#get-a-gitignore-template", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"C\",\"source\":\"# Object files\\n*.o\\n\\n# Libraries\\n*.lib\\n*.a\\n\\n# Shared objects (inc. Windows DLLs)\\n*.dll\\n*.so\\n*.so.*\\n*.dylib\\n\\n# Executables\\n*.exe\\n*.out\\n*.app\\n\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Add assignees to an issue", - "scope": "issues", - "id": "addAssignees", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "isDeprecated": false, - "deprecationDate": null, - "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#add-assignees-to-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add labels to an issue", - "scope": "issues", - "id": "addLabels", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#add-labels-to-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels[].name", - "description": "", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check if a user can be assigned", - "scope": "issues", - "id": "checkUserCanBeAssigned", - "method": "GET", - "url": "/repos/{owner}/{repo}/assignees/{assignee}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#check-if-a-user-can-be-assigned", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.", - "examples": null - }, - { - "code": 404, - "description": "Otherwise a `404` status code is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create an issue", - "scope": "issues", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#create-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the issue.", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the issue.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", - "in": "BODY", - "type": "undefined[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Create an issue comment", - "scope": "issues", - "id": "createComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#create-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a label", - "scope": "issues", - "id": "createLabel", - "method": "POST", - "url": "/repos/{owner}/{repo}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#create-a-label", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "color", - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the label. Must be 100 characters or fewer.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}" - } - ] - }, - { "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 a milestone", - "scope": "issues", - "id": "createMilestone", - "method": "POST", - "url": "/repos/{owner}/{repo}/milestones", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#create-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the milestone.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the milestone. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A description of the milestone.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "due_on", - "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete an issue comment", - "scope": "issues", - "id": "deleteComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#delete-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a label", - "scope": "issues", - "id": "deleteLabel", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#delete-a-label", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "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": "Delete a milestone", - "scope": "issues", - "id": "deleteMilestone", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#delete-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone_number", - "description": "The number that identifies the milestone.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an issue", - "scope": "issues", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#get-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an issue comment", - "scope": "issues", - "id": "getComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#get-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an issue event", - "scope": "issues", - "id": "getEvent", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/events/{event_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#get-an-issue-event", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"issue\":{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"performed_via_github_app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a label", - "scope": "issues", - "id": "getLabel", - "method": "GET", - "url": "/repos/{owner}/{repo}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#get-a-label", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a milestone", - "scope": "issues", - "id": "getMilestone", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#get-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone_number", - "description": "The number that identifies the milestone.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List issues assigned to the authenticated user", - "scope": "issues", - "id": "list", - "method": "GET", - "url": "/issues", - "isDeprecated": false, - "deprecationDate": 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 v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-issues-assigned-to-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "filter", - "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "collab", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "orgs", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owned", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pulls", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "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": "List assignees", - "scope": "issues", - "id": "listAssignees", - "method": "GET", - "url": "/repos/{owner}/{repo}/assignees", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-assignees", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List issue comments", - "scope": "issues", - "id": "listComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Issue Comments are ordered by ascending ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-issue-comments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List issue comments for a repository", - "scope": "issues", - "id": "listCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "By default, Issue Comments are ordered by ascending ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-issue-comments-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "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 issue events", - "scope": "issues", - "id": "listEvents", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-issue-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"performed_via_github_app\":null,\"label\":{\"name\":\"label\",\"color\":\"red\"}}]" - } - ] - }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List issue events for a repository", - "scope": "issues", - "id": "listEventsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/events", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-issue-events-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"issue\":{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List timeline events for an issue", - "scope": "issues", - "id": "listEventsForTimeline", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-timeline-events-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":6430295168,\"node_id\":\"LOE_lADODwFebM5HwC0kzwAAAAF_RoSA\",\"url\":\"https://api.github.com/repos/github/roadmap/issues/events/6430295168\",\"actor\":{\"login\":\"github\",\"id\":9919,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjk5MTk=\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/9919?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/users/github/repos\",\"events_url\":\"https://api.github.com/users/github/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"event\":\"locked\",\"commit_id\":null,\"commit_url\":null,\"created_at\":\"2022-04-13T20:49:13Z\",\"lock_reason\":null,\"performed_via_github_app\":null},{\"id\":6430296748,\"node_id\":\"LE_lADODwFebM5HwC0kzwAAAAF_Roqs\",\"url\":\"https://api.github.com/repos/github/roadmap/issues/events/6430296748\",\"actor\":{\"login\":\"github-product-roadmap\",\"id\":67656570,\"node_id\":\"MDQ6VXNlcjY3NjU2NTcw\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/67656570?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github-product-roadmap\",\"html_url\":\"https://github.com/github-product-roadmap\",\"followers_url\":\"https://api.github.com/users/github-product-roadmap/followers\",\"following_url\":\"https://api.github.com/users/github-product-roadmap/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github-product-roadmap/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github-product-roadmap/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github-product-roadmap/orgs\",\"repos_url\":\"https://api.github.com/users/github-product-roadmap/repos\",\"events_url\":\"https://api.github.com/users/github-product-roadmap/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github-product-roadmap/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"labeled\",\"commit_id\":null,\"commit_url\":null,\"created_at\":\"2022-04-13T20:49:34Z\",\"label\":{\"name\":\"beta\",\"color\":\"99dd88\"},\"performed_via_github_app\":null},{\"id\":6635165802,\"node_id\":\"RTE_lADODwFebM5HwC0kzwAAAAGLfJhq\",\"url\":\"https://api.github.com/repos/github/roadmap/issues/events/6635165802\",\"actor\":{\"login\":\"github-product-roadmap\",\"id\":67656570,\"node_id\":\"MDQ6VXNlcjY3NjU2NTcw\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/67656570?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/github-product-roadmap\",\"html_url\":\"https://github.com/github-product-roadmap\",\"followers_url\":\"https://api.github.com/users/github-product-roadmap/followers\",\"following_url\":\"https://api.github.com/users/github-product-roadmap/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github-product-roadmap/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github-product-roadmap/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github-product-roadmap/orgs\",\"repos_url\":\"https://api.github.com/users/github-product-roadmap/repos\",\"events_url\":\"https://api.github.com/users/github-product-roadmap/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/github-product-roadmap/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"renamed\",\"commit_id\":null,\"commit_url\":null,\"created_at\":\"2022-05-18T19:29:01Z\",\"rename\":{\"from\":\"Secret scanning: dry-runs for enterprise-level custom patterns (cloud)\",\"to\":\"Secret scanning: dry-runs for enterprise-level custom patterns\"},\"performed_via_github_app\":null},{\"url\":\"https://api.github.com/repos/github/roadmap/issues/comments/1130876857\",\"html_url\":\"https://github.com/github/roadmap/issues/493#issuecomment-1130876857\",\"issue_url\":\"https://api.github.com/repos/github/roadmap/issues/493\",\"id\":1130876857,\"node_id\":\"IC_kwDODwFebM5DZ8-5\",\"user\":{\"login\":\"octocat\",\"id\":94867353,\"node_id\":\"U_kgDOBaePmQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/94867353?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"created_at\":\"2022-05-19T00:52:15Z\",\"updated_at\":\"2022-05-19T00:52:15Z\",\"author_association\":\"COLLABORATOR\",\"body\":\"🚢 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/\",\"reactions\":{\"url\":\"https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions\",\"total_count\":0,\"+1\":0,\"-1\":0,\"laugh\":0,\"hooray\":0,\"confused\":0,\"heart\":0,\"rocket\":0,\"eyes\":0},\"performed_via_github_app\":null,\"event\":\"commented\",\"actor\":{\"login\":\"octocat\",\"id\":94867353,\"node_id\":\"U_kgDOBaePmQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/94867353?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List user account issues assigned to the authenticated user", - "scope": "issues", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "filter", - "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List organization issues assigned to the authenticated user", - "scope": "issues", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-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": "filter", - "description": "Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "repos", - "all" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1},\"author_association\":\"COLLABORATOR\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository issues", - "scope": "issues", - "id": "listForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-repository-issues", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone", - "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "creator", - "description": "The user that created the issue.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "mentioned", - "description": "A user that's mentioned in the issue.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "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": "List labels for issues in a milestone", - "scope": "issues", - "id": "listLabelsForMilestone", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-labels-for-issues-in-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone_number", - "description": "The number that identifies the milestone.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List labels for a repository", - "scope": "issues", - "id": "listLabelsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-labels-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List labels for an issue", - "scope": "issues", - "id": "listLabelsOnIssue", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-labels-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List milestones", - "scope": "issues", - "id": "listMilestones", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#list-milestones", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the milestone. Either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by. Either `due_on` or `completeness`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["due_on", "completeness"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction of the sort. Either `asc` or `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Lock an issue", - "scope": "issues", - "id": "lock", - "method": "PUT", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#lock-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "lock_reason", - "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["off-topic", "too heated", "resolved", "spam"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove all labels from an issue", - "scope": "issues", - "id": "removeAllLabels", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#remove-all-labels-from-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove assignees from an issue", - "scope": "issues", - "id": "removeAssignees", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes one or more assignees from an issue.", - "documentationUrl": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove a label from an issue", - "scope": "issues", - "id": "removeLabel", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#remove-a-label-from-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Set labels for an issue", - "scope": "issues", - "id": "setLabels", - "method": "PUT", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes any previous labels and sets the new labels for an issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#set-labels-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels[].name", - "description": "", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Unlock an issue", - "scope": "issues", - "id": "unlock", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access can unlock an issue's conversation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#unlock-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an issue", - "scope": "issues", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/issues/{issue_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Issue owners and users with push access can edit an issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues/#update-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the issue.", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the issue.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "State of the issue. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state_reason", - "description": "The reason for the current state", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["completed", "not_planned", "reopened"], - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", - "in": "BODY", - "type": "undefined[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "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\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"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},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an issue comment", - "scope": "issues", - "id": "updateComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#update-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a label", - "scope": "issues", - "id": "updateLabel", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/labels/{name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#update-a-label", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "new_name", - "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see \"[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "color", - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the label. Must be 100 characters or fewer.", - "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\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:\",\"name\":\"bug :bug:\",\"description\":\"Small bug fix required\",\"color\":\"b01f26\",\"default\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a milestone", - "scope": "issues", - "id": "updateMilestone", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#update-a-milestone", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone_number", - "description": "The number that identifies the milestone.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the milestone.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the milestone. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A description of the milestone.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "due_on", - "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a license", - "scope": "licenses", - "id": "get", - "method": "GET", - "url": "/licenses/{license}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/licenses#get-a-license", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "license", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"http://choosealicense.com/licenses/mit/\",\"description\":\"A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.\",\"implementation\":\"Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.\",\"permissions\":[\"commercial-use\",\"modifications\",\"distribution\",\"sublicense\",\"private-use\"],\"conditions\":[\"include-copyright\"],\"limitations\":[\"no-liability\"],\"body\":\"\\n\\nThe MIT License (MIT)\\n\\nCopyright (c) [year] [fullname]\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in all\\ncopies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\\nSOFTWARE.\\n\",\"featured\":true}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all commonly used licenses", - "scope": "licenses", - "id": "getAllCommonlyUsed", - "method": "GET", - "url": "/licenses", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/licenses#get-all-commonly-used-licenses", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "featured", - "description": "", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"lgpl-3.0\",\"name\":\"GNU Lesser General Public License v3.0\",\"spdx_id\":\"LGPL-3.0\",\"url\":\"https://api.github.com/licenses/lgpl-3.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"mpl-2.0\",\"name\":\"Mozilla Public License 2.0\",\"spdx_id\":\"MPL-2.0\",\"url\":\"https://api.github.com/licenses/mpl-2.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"agpl-3.0\",\"name\":\"GNU Affero General Public License v3.0\",\"spdx_id\":\"AGPL-3.0\",\"url\":\"https://api.github.com/licenses/agpl-3.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"unlicense\",\"name\":\"The Unlicense\",\"spdx_id\":\"Unlicense\",\"url\":\"https://api.github.com/licenses/unlicense\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"apache-2.0\",\"name\":\"Apache License 2.0\",\"spdx_id\":\"Apache-2.0\",\"url\":\"https://api.github.com/licenses/apache-2.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"gpl-3.0\",\"name\":\"GNU General Public License v3.0\",\"spdx_id\":\"GPL-3.0\",\"url\":\"https://api.github.com/licenses/gpl-3.0\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the license for a repository", - "scope": "licenses", - "id": "getForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/license", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/repos#get-repository-content), this method also supports [custom media types](https://docs.github.com/enterprise-server@3.3/rest/overview/media-types) for retrieving the raw license content or rendered license HTML.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/licenses/#get-the-license-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"LICENSE\",\"path\":\"LICENSE\",\"sha\":\"401c59dcc4570b954dd6d345e76199e1f4e76266\",\"size\":1077,\"url\":\"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\"html_url\":\"https://github.com/benbalter/gman/blob/master/LICENSE\",\"git_url\":\"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\"download_url\":\"https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true\",\"type\":\"file\",\"content\":\"VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\\n\",\"encoding\":\"base64\",\"_links\":{\"self\":\"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\"git\":\"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\"html\":\"https://github.com/benbalter/gman/blob/master/LICENSE\"},\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Render a Markdown document", - "scope": "markdown", - "id": "render", - "method": "POST", - "url": "/markdown", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/markdown#render-a-markdown-document", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "text", - "description": "The Markdown text to render in HTML.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "mode", - "description": "The rendering mode.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["markdown", "gfm"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "context", - "description": "The repository context to use when creating references in `gfm` mode. For example, setting `context` to `octo-org/octo-repo` will change the text `#42` into an HTML link to issue 42 in the `octo-org/octo-repo` repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Render a Markdown document in raw mode", - "scope": "markdown", - "id": "renderRaw", - "method": "POST", - "url": "/markdown/raw", - "isDeprecated": false, - "deprecationDate": null, - "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/markdown#render-a-markdown-document-in-raw-mode", - "previews": [], - "headers": [ - { "name": "content-type", "value": "text/plain; charset=utf-8" } - ], - "parameters": [ - { - "name": "data", - "description": "raw markdown text", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get GitHub Enterprise Server meta information", - "scope": "meta", - "id": "get", - "method": "GET", - "url": "/meta", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/meta#get-github-meta-information", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"verifiable_password_authentication\":true,\"packages\":[\"192.30.252.0/22\"],\"dependabot\":[\"54.158.161.132\"],\"installed_version\":\"3.3.0\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Get Octocat", - "scope": "meta", - "id": "getOctocat", - "method": "GET", - "url": "/octocat", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get the octocat as ASCII art", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/meta#get-octocat", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "s", - "description": "The words to show in Octocat's speech bubble", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "\" MMM. .MMM\\n MMMMMMMMMMMMMMMMMMM\\n MMMMMMMMMMMMMMMMMMM ___________________________________\\n MMMMMMMMMMMMMMMMMMMMM | |\\n MMMMMMMMMMMMMMMMMMMMMMM | Avoid administrative distraction. |\\n MMMMMMMMMMMMMMMMMMMMMMMM |_ _______________________________|\\n MMMM::- -:::::::- -::MMMM |/\\n MM~:~ 00~:::::~ 00~:~MM\\n .. MMMMM::.00:::+:::.00::MMMMM ..\\n .MM::::: ._. :::::MM.\\n MMMM;:::::;MMMM\\n -MM MMMMMMM\\n ^ M+ MMMMMMMMM\\n MMMMMMM MM MM MM\\n MM MM MM MM\\n MM MM MM MM\\n .~~MM~MM~MM~MM~~.\\n ~~~~MM:~MM~~~MM~:MM~~~~\\n ~~~~~~==~==~~~==~==~~~~~~\\n ~~~~~~==~==~==~==~~~~~~\\n :~==~==~==~==~~\\n\"" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the Zen of GitHub", - "scope": "meta", - "id": "getZen", - "method": "GET", - "url": "/zen", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get a random sentence from the Zen of GitHub", - "documentationUrl": "", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "\"Responsive is better than fast\"" }] - } - ], - "renamed": null - }, - { - "name": "GitHub API Root", - "scope": "meta", - "id": "root", - "method": "GET", - "url": "/", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get Hypermedia links to resources accessible in GitHub's REST API", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#root-endpoint", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"current_user_url\":\"https://api.github.com/user\",\"current_user_authorizations_html_url\":\"https://github.com/settings/connections/applications{/client_id}\",\"authorizations_url\":\"https://api.github.com/authorizations\",\"code_search_url\":\"https://api.github.com/search/code?q={query}{&page,per_page,sort,order}\",\"commit_search_url\":\"https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}\",\"emails_url\":\"https://api.github.com/user/emails\",\"emojis_url\":\"https://api.github.com/emojis\",\"events_url\":\"https://api.github.com/events\",\"feeds_url\":\"https://api.github.com/feeds\",\"followers_url\":\"https://api.github.com/user/followers\",\"following_url\":\"https://api.github.com/user/following{/target}\",\"gists_url\":\"https://api.github.com/gists{/gist_id}\",\"hub_url\":\"https://api.github.com/hub\",\"issue_search_url\":\"https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}\",\"issues_url\":\"https://api.github.com/issues\",\"keys_url\":\"https://api.github.com/user/keys\",\"label_search_url\":\"https://api.github.com/search/labels?q={query}&repository_id={repository_id}{&page,per_page}\",\"notifications_url\":\"https://api.github.com/notifications\",\"organization_url\":\"https://api.github.com/orgs/{org}\",\"organization_repositories_url\":\"https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}\",\"organization_teams_url\":\"https://api.github.com/orgs/{org}/teams\",\"public_gists_url\":\"https://api.github.com/gists/public\",\"rate_limit_url\":\"https://api.github.com/rate_limit\",\"repository_url\":\"https://api.github.com/repos/{owner}/{repo}\",\"repository_search_url\":\"https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}\",\"current_user_repositories_url\":\"https://api.github.com/user/repos{?type,page,per_page,sort}\",\"starred_url\":\"https://api.github.com/user/starred{/owner}{/repo}\",\"starred_gists_url\":\"https://api.github.com/gists/starred\",\"topic_search_url\":\"https://api.github.com/search/topics?q={query}{&page,per_page}\",\"user_url\":\"https://api.github.com/users/{user}\",\"user_organizations_url\":\"https://api.github.com/user/orgs\",\"user_repositories_url\":\"https://api.github.com/users/{user}/repos{?type,page,per_page,sort}\",\"user_search_url\":\"https://api.github.com/search/users?q={query}{&page,per_page,sort,order}\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Check organization membership for a user", - "scope": "orgs", - "id": "checkMembershipForUser", - "method": "GET", - "url": "/orgs/{org}/members/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Check if a user is, publicly or privately, a member of the organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#check-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 - } - ], - "responses": [ - { - "code": 204, - "description": "Response if requester is an organization member and user is a member", - "examples": null - }, - { - "code": 302, - "description": "Response if requester is not an organization member", - "examples": null - }, - { - "code": 404, - "description": "Not Found if requester is an organization member and user is not a member", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check public organization membership for a user", - "scope": "orgs", - "id": "checkPublicMembershipForUser", - "method": "GET", - "url": "/orgs/{org}/public_members/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#check-public-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 - } - ], - "responses": [ - { - "code": 204, - "description": "Response if user is a public member", - "examples": null - }, - { - "code": 404, - "description": "Not Found if user is not a public member", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Convert an organization member to outside collaborator", - "scope": "orgs", - "id": "convertMemberToOutsideCollaborator", - "method": "PUT", - "url": "/orgs/{org}/outside_collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.3/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator", - "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": "async", - "description": "When set to `true`, the request will be performed asynchronously. Returns a 202 status code when the job is successfully queued.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "User is getting converted asynchronously", - "examples": [{ "data": "null" }] - }, - { "code": 204, "description": "User was converted", "examples": null }, - { - "code": 403, - "description": "Forbidden if user is the last owner of the organization or not a member of the organization.", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create an organization webhook", - "scope": "orgs", - "id": "createWebhook", - "method": "POST", - "url": "/orgs/{org}/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Here's how you can create a hook that posts payloads in JSON format:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#create-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Must be passed as \"web\".", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#create-hook-config-params).", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.username", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.password", - "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/enterprise-server@3.3/webhooks/event-payloads) the hook is triggered for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"deliveries_url\":\"https://api.github.com/orgs/octocat/hooks/1/deliveries\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete an organization webhook", - "scope": "orgs", - "id": "deleteWebhook", - "method": "DELETE", - "url": "/orgs/{org}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#delete-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an organization", - "scope": "orgs", - "id": "get", - "method": "GET", - "url": "/orgs/{org}", - "isDeprecated": false, - "deprecationDate": 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 Enterprise Server plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#get-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": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"filled_seats\":4,\"seats\":5},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an organization membership for the authenticated user", - "scope": "orgs", - "id": "getMembershipForAuthenticatedUser", - "method": "GET", - "url": "/user/memberships/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#get-an-organization-membership-for-the-authenticated-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 - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"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": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get organization membership for a user", - "scope": "orgs", - "id": "getMembershipForUser", - "method": "GET", - "url": "/orgs/{org}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member. The `state` parameter in the response can be used to identify the user's membership status.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#get-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 - } - ], - "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": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an organization webhook", - "scope": "orgs", - "id": "getWebhook", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#get-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"deliveries_url\":\"https://api.github.com/orgs/octocat/hooks/1/deliveries\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a webhook configuration for an organization", - "scope": "orgs", - "id": "getWebhookConfigForOrg", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}/config", - "isDeprecated": false, - "deprecationDate": 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/reference/orgs#get-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#get-a-webhook-configuration-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a webhook delivery for an organization webhook", - "scope": "orgs", - "id": "getWebhookDelivery", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a delivery for a webhook configured in an organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#get-a-webhook-delivery-for-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delivery_id", - "description": "", - "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\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"url\":\"https://www.example.com\",\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List organizations", - "scope": "orgs", - "id": "list", - "method": "GET", - "url": "/organizations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#list-organizations", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "An organization ID. Only return organizations with an ID greater than this ID.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "List app installations for an organization", - "scope": "orgs", - "id": "listAppInstallations", - "method": "GET", - "url": "/orgs/{org}/installations", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#list-app-installations-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"installations\":[{\"id\":25381,\"account\":{\"login\":\"octo-org\",\"id\":6811672,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=\",\"avatar_url\":\"https://avatars3.githubusercontent.com/u/6811672?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"selected\",\"access_tokens_url\":\"https://api.github.com/app/installations/25381/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/octo-org/settings/installations/25381\",\"app_id\":2218,\"target_id\":6811672,\"target_type\":\"Organization\",\"permissions\":{\"deployments\":\"write\",\"metadata\":\"read\",\"pull_requests\":\"read\",\"statuses\":\"read\"},\"events\":[\"deployment\",\"deployment_status\"],\"created_at\":\"2017-05-16T08:47:09.000-07:00\",\"updated_at\":\"2017-06-06T11:23:23.000-07:00\",\"single_file_name\":\"config.yml\",\"has_multiple_single_files\":true,\"single_file_paths\":[\"config.yml\",\".github/issue_TEMPLATE.md\"],\"app_slug\":\"github-actions\",\"suspended_at\":null,\"suspended_by\":null}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organizations for the authenticated user", - "scope": "orgs", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/orgs", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#list-organizations-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List organizations for a user", - "scope": "orgs", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/orgs", - "isDeprecated": false, - "deprecationDate": null, - "description": "List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#list-organizations-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organization members", - "scope": "orgs", - "id": "listMembers", - "method": "GET", - "url": "/orgs/{org}/members", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#list-organization-members", - "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": "filter", - "description": "Filter members returned in the list. `2fa_disabled` means that only members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. This options is only available for organization owners.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["2fa_disabled", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "Filter members returned by their role.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "admin", "member"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List organization memberships for the authenticated user", - "scope": "orgs", - "id": "listMembershipsForAuthenticatedUser", - "method": "GET", - "url": "/user/memberships/orgs", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#list-organization-memberships-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "state", - "description": "Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["active", "pending"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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}},{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"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": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "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", - "id": "listOutsideCollaborators", - "method": "GET", - "url": "/orgs/{org}/outside_collaborators", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all users who are outside collaborators of an organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#list-outside-collaborators-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["2fa_disabled", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public organization members", - "scope": "orgs", - "id": "listPublicMembers", - "method": "GET", - "url": "/orgs/{org}/public_members", - "isDeprecated": false, - "deprecationDate": null, - "description": "Members of an organization can choose to have their membership publicized or not.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#list-public-organization-members", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List deliveries for an organization webhook", - "scope": "orgs", - "id": "listWebhookDeliveries", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}/deliveries", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#list-deliveries-for-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "cursor", - "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456},{\"id\":123456789,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-04T00:57:16Z\",\"redelivery\":true,\"duration\":0.28,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456}]" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List organization webhooks", - "scope": "orgs", - "id": "listWebhooks", - "method": "GET", - "url": "/orgs/{org}/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#list-organization-webhooks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"deliveries_url\":\"https://api.github.com/orgs/octocat/hooks/1/deliveries\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Ping an organization webhook", - "scope": "orgs", - "id": "pingWebhook", - "method": "POST", - "url": "/orgs/{org}/hooks/{hook_id}/pings", - "isDeprecated": false, - "deprecationDate": null, - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.3/webhooks/#ping-event) to be sent to the hook.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#ping-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Redeliver a delivery for an organization webhook", - "scope": "orgs", - "id": "redeliverWebhookDelivery", - "method": "POST", - "url": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Redeliver a delivery for a webhook configured in an organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#redeliver-a-delivery-for-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delivery_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove an organization member", - "scope": "orgs", - "id": "removeMember", - "method": "DELETE", - "url": "/orgs/{org}/members/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#remove-an-organization-member", - "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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove organization membership for a user", - "scope": "orgs", - "id": "removeMembershipForUser", - "method": "DELETE", - "url": "/orgs/{org}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#remove-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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove outside collaborator from an organization", - "scope": "orgs", - "id": "removeOutsideCollaborator", - "method": "DELETE", - "url": "/orgs/{org}/outside_collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removing a user from this list will remove them from all the organization's repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#remove-outside-collaborator-from-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 422, - "description": "Unprocessable Entity if user is a member of the organization", - "examples": [ - { - "data": "{\"message\":\"You cannot specify an organization member to remove as an outside collaborator.\",\"documentation_url\":\"https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#remove-outside-collaborator\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove public organization membership for the authenticated user", - "scope": "orgs", - "id": "removePublicMembershipForAuthenticatedUser", - "method": "DELETE", - "url": "/orgs/{org}/public_members/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-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 - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Set organization membership for a user", - "scope": "orgs", - "id": "setMembershipForUser", - "method": "PUT", - "url": "/orgs/{org}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/orgs#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/enterprise-server@3.3/rest/reference/orgs#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, - "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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an organization", - "scope": "orgs", - "id": "update", - "method": "PATCH", - "url": "/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs/#update-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "billing_email", - "description": "Billing email address. This address is not publicized.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "company", - "description": "The company name.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "email", - "description": "The publicly visible email address.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "twitter_username", - "description": "The Twitter username of the company.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "location", - "description": "The location.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The shorthand name of the company.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the company.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_organization_projects", - "description": "Whether an organization can use organization projects.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_repository_projects", - "description": "Whether repositories that belong to the organization can use repository projects.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "default_repository_permission", - "description": "Default permission level members have for organization repositories.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin", "none"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_repositories", - "description": "Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_internal_repositories", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_private_repositories", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_public_repositories", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_allowed_repository_creation_type", - "description": "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "private", "none"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_pages", - "description": "Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "blog", - "description": "", - "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": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"twitter_username\":\"github\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"mona@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false,\"members_can_create_pages\":true,\"members_can_create_public_pages\":true,\"members_can_create_private_pages\":true,\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { "code": 409, "description": "Conflict", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null } - ], - "renamed": null - }, - { - "name": "Update an organization membership for the authenticated user", - "scope": "orgs", - "id": "updateMembershipForAuthenticatedUser", - "method": "PATCH", - "url": "/user/memberships/orgs/{org}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#update-an-organization-membership-for-the-authenticated-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": "state", - "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["active"], - "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": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update an organization webhook", - "scope": "orgs", - "id": "updateWebhook", - "method": "PATCH", - "url": "/orgs/{org}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#update-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#update-hook-config-params).", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "events", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads) the hook is triggered for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "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\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"deliveries_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries\",\"name\":\"web\",\"events\":[\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"type\":\"Organization\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a webhook configuration for an organization", - "scope": "orgs", - "id": "updateWebhookConfigForOrg", - "method": "PATCH", - "url": "/orgs/{org}/hooks/{hook_id}/config", - "isDeprecated": false, - "deprecationDate": 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/reference/orgs#update-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/orgs#update-a-webhook-configuration-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add project collaborator", - "scope": "projects", - "id": "addCollaborator", - "method": "PUT", - "url": "/projects/{project_id}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#add-project-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "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": "permission", - "description": "The permission to grant the collaborator.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a project card", - "scope": "projects", - "id": "createCard", - "method": "POST", - "url": "/projects/columns/{column_id}/cards", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#create-a-project-card", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "note", - "description": "The project card's note", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_id", - "description": "The unique identifier of the content associated with the card", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_type", - "description": "The piece of content associated with the card", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 422, "description": "Validation failed", "examples": null }, - { "code": 503, "description": "Response", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a project column", - "scope": "projects", - "id": "createColumn", - "method": "POST", - "url": "/projects/{project_id}/columns", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#create-a-project-column", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Name of the project column", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a user project", - "scope": "projects", - "id": "createForAuthenticatedUser", - "method": "POST", - "url": "/user/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#create-a-user-project", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "Name of the project", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "Body of the project", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/users/octocat\",\"url\":\"https://api.github.com/projects/1002603\",\"html_url\":\"https://github.com/users/octocat/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002603/columns\",\"id\":1002603,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDM=\",\"name\":\"My Projects\",\"body\":\"A board to manage my personal projects.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create an organization project", - "scope": "projects", - "id": "createForOrg", - "method": "POST", - "url": "/orgs/{org}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#create-an-organization-project", - "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": "name", - "description": "The name of the project.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The description of the project.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a repository project", - "scope": "projects", - "id": "createForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#create-a-repository-project", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the project.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The description of the project.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a project", - "scope": "projects", - "id": "delete", - "method": "DELETE", - "url": "/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#delete-a-project", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Delete Success", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a project card", - "scope": "projects", - "id": "deleteCard", - "method": "DELETE", - "url": "/projects/columns/cards/{card_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#delete-a-project-card", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a project column", - "scope": "projects", - "id": "deleteColumn", - "method": "DELETE", - "url": "/projects/columns/{column_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#delete-a-project-column", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a project", - "scope": "projects", - "id": "get", - "method": "GET", - "url": "/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#get-a-project", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "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": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a project card", - "scope": "projects", - "id": "getCard", - "method": "GET", - "url": "/projects/columns/cards/{card_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#get-a-project-card", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a project column", - "scope": "projects", - "id": "getColumn", - "method": "GET", - "url": "/projects/columns/{column_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#get-a-project-column", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get project permission for a user", - "scope": "projects", - "id": "getPermissionForUser", - "method": "GET", - "url": "/projects/{project_id}/collaborators/{username}/permission", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#get-project-permission-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List project cards", - "scope": "projects", - "id": "listCards", - "method": "GET", - "url": "/projects/columns/{column_id}/cards", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#list-project-cards", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "archived", "not_archived"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List project collaborators", - "scope": "projects", - "id": "listCollaborators", - "method": "GET", - "url": "/projects/{project_id}/collaborators", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the collaborators for an organization project. For a project, 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. You must be an organization owner or a project `admin` to list collaborators.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#list-project-collaborators", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["outside", "direct", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List project columns", - "scope": "projects", - "id": "listColumns", - "method": "GET", - "url": "/projects/{project_id}/columns", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#list-project-columns", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List organization projects", - "scope": "projects", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#list-organization-projects", - "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": "state", - "description": "Indicates the state of the projects to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List repository projects", - "scope": "projects", - "id": "listForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#list-repository-projects", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}]" - } - ] - }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List user projects", - "scope": "projects", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#list-user-projects", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the projects to return.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/users/octocat\",\"url\":\"https://api.github.com/projects/1002603\",\"html_url\":\"https://github.com/users/octocat/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002603/columns\",\"id\":1002603,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDM=\",\"name\":\"My Projects\",\"body\":\"A board to manage my personal projects.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Move a project card", - "scope": "projects", - "id": "moveCard", - "method": "POST", - "url": "/projects/columns/cards/{card_id}/moves", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#move-a-project-card", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "The position of the card in a column. Can be one of: `top`, `bottom`, or `after:` to place after the specified card.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:top|bottom|after:\\d+)$", - "alias": null, - "deprecated": null - }, - { - "name": "column_id", - "description": "The unique identifier of the column the card should be moved to", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [{ "data": "null" }] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Response", "examples": null } - ], - "renamed": null - }, - { - "name": "Move a project column", - "scope": "projects", - "id": "moveColumn", - "method": "POST", - "url": "/projects/columns/{column_id}/moves", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#move-a-project-column", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "The position of the column in a project. Can be one of: `first`, `last`, or `after:` to place after the specified column.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(?:first|last|after:\\d+)$", - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [{ "data": "null" }] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove user as a collaborator", - "scope": "projects", - "id": "removeCollaborator", - "method": "DELETE", - "url": "/projects/{project_id}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#remove-project-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a project", - "scope": "projects", - "id": "update", - "method": "PATCH", - "url": "/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#update-a-project", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Name of the project", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "Body of the project", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "State of the project; either 'open' or 'closed'", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "organization_permission", - "description": "The baseline permission that all organization members have on this project", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin", "none"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Whether or not this project can be seen by everyone.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if the authenticated user does not have access to the project", - "examples": null - }, - { "code": 410, "description": "Gone", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update an existing project card", - "scope": "projects", - "id": "updateCard", - "method": "PATCH", - "url": "/projects/columns/cards/{card_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#update-a-project-card", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "note", - "description": "The project card's note", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "archived", - "description": "Whether or not the card is archived", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update an existing project column", - "scope": "projects", - "id": "updateColumn", - "method": "PATCH", - "url": "/projects/columns/{column_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/projects#update-a-project-column", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Name of the project column", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Check if a pull request has been merged", - "scope": "pulls", - "id": "checkIfMerged", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#check-if-a-pull-request-has-been-merged", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if pull request has been merged", - "examples": null - }, - { - "code": 404, - "description": "Not Found if pull request has not been merged", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a pull request", - "scope": "pulls", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls", - "isDeprecated": false, - "deprecationDate": 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#create-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the new pull request. Required unless `issue` is specified.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the pull request.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "draft", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue", - "description": "An issue in the repository to convert to a pull request. The issue title, body, and comments will become the title, body, and comments on the new pull request. Required unless `title` is specified.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a reply for a review comment", - "scope": "pulls", - "id": "createReplyForReviewComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - "isDeprecated": false, - "deprecationDate": 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#create-a-reply-for-a-review-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The text of the review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":426899381,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a review for a pull request", - "scope": "pulls", - "id": "createReview", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/pulls#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 v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/reference/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#create-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_id", - "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.3/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments", - "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].path", - "description": "The relative path to the file that necessitates a review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "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.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].body", - "description": "Text of the review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].line", - "description": "", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].side", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].start_line", - "description": "", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments[].start_side", - "description": "", - "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\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change.\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a review comment for a pull request", - "scope": "pulls", - "id": "createReviewComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#create-a-review-comment-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The text of the review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_id", - "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "The relative path to the file that necessitates a comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "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.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "side", - "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["LEFT", "RIGHT"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "line", - "description": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "start_line", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "start_side", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["LEFT", "RIGHT", "side"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "in_reply_to", - "description": "The ID of the review comment to reply to. To find the ID of a review comment with [\"List review comments on a pull request\"](#list-review-comments-on-a-pull-request). When specified, all parameters other than `body` in the request body are ignored.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a pending review for a pull request", - "scope": "pulls", - "id": "deletePendingReview", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#delete-a-pending-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "The unique identifier of the review.", - "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\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change.\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a review comment for a pull request", - "scope": "pulls", - "id": "deleteReviewComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a review comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#delete-a-review-comment-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Dismiss a review for a pull request", - "scope": "pulls", - "id": "dismissReview", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#branches), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#dismiss-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "The unique identifier of the review.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The message for the pull request review dismissal", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["DISMISS"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"state\":\"DISMISSED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a pull request", - "scope": "pulls", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server 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/enterprise-server@3.3/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 Enterprise Server 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/enterprise-server@3.3/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#get-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.3/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a review for a pull request", - "scope": "pulls", - "id": "getReview", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#get-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "The unique identifier of the review.", - "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\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a review comment for a pull request", - "scope": "pulls", - "id": "getReviewComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Provides details for a review comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#get-a-review-comment-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List pull requests", - "scope": "pulls", - "id": "list", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Either `open`, `closed`, or `all` to filter by state.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "Filter pulls by base branch name. Example: `gh-pages`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by. `popularity` will sort by the number of comments. `long-running` will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "popularity", "long-running"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List comments for a pull request review", - "scope": "pulls", - "id": "listCommentsForReview", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "List comments for a specific pull request review.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-comments-for-a-pull-request-review", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "The unique identifier of the review.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List commits on a pull request", - "scope": "pulls", - "id": "listCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/repos#list-commits) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-commits-on-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pull requests files", - "scope": "pulls", - "id": "listFiles", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests-files", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 500, "description": "Internal Error", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all requested reviewers for a pull request", - "scope": "pulls", - "id": "listRequestedReviewers", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the [List reviews for a pull request](https://docs.github.com/enterprise-server@3.3/rest/pulls/reviews#list-reviews-for-a-pull-request) operation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#get-all-requested-reviewers-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "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": "{\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List review comments on a pull request", - "scope": "pulls", - "id": "listReviewComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all review comments for a pull request. By default, review comments are in ascending order by ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-review-comments-on-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort results. Ignored without `sort` parameter.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List review comments in a repository", - "scope": "pulls", - "id": "listReviewCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-review-comments-in-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "created_at"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort results. Ignored without `sort` parameter.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reviews for a pull request", - "scope": "pulls", - "id": "listReviews", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "The list of reviews returns in chronological order.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-reviews-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The list of reviews returns in chronological order.", - "examples": [ - { - "data": "[{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Merge a pull request", - "scope": "pulls", - "id": "merge", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#merge-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_title", - "description": "Title for the automatic commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_message", - "description": "Extra detail to append to automatic commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "SHA that pull request head must match to allow merge.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_method", - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["merge", "squash", "rebase"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if merge was successful", - "examples": [ - { - "data": "{\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"merged\":true,\"message\":\"Pull Request successfully merged\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 405, - "description": "Method Not Allowed if merge cannot be performed", - "examples": [ - { "data": "{\"message\":\"Pull Request is not mergeable\"}" } - ] - }, - { - "code": 409, - "description": "Conflict if sha was provided and pull request head did not match", - "examples": [ - { - "data": "{\"message\":\"Head branch was modified. Review and try the merge again.\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove requested reviewers from a pull request", - "scope": "pulls", - "id": "removeRequestedReviewers", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#remove-requested-reviewers-from-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reviewers", - "description": "An array of user `login`s that will be removed.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_reviewers", - "description": "An array of team `slug`s that will be removed.", - "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": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Request reviewers for a pull request", - "scope": "pulls", - "id": "requestReviewers", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#request-reviewers-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reviewers", - "description": "An array of user `login`s that will be requested.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_reviewers", - "description": "An array of team `slug`s that will be requested.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Unprocessable Entity if user is not a collaborator", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Submit a review for a pull request", - "scope": "pulls", - "id": "submitReview", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/pulls#create-a-review-for-a-pull-request).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#submit-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "The unique identifier of the review.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body text of the pull request review", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { "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": "Update a pull request", - "scope": "pulls", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls/#update-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the pull request.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the pull request.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "State of this Pull Request. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a pull request branch", - "scope": "pulls", - "id": "updateBranch", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#update-a-pull-request-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "expected_head_sha", - "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-commits)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 202, - "description": "Response", - "examples": [ - { - "data": "{\"message\":\"Updating pull request branch.\",\"url\":\"https://github.com/repos/octocat/Hello-World/pulls/53\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a review for a pull request", - "scope": "pulls", - "id": "updateReview", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Update the review summary comment with new text.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#update-a-review-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "The unique identifier of the review.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body text of the pull request review.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change. And add more about this.\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}},\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"author_association\":\"COLLABORATOR\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a review comment for a pull request", - "scope": "pulls", - "id": "updateReviewComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Enables you to edit a review comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#update-a-review-comment-for-a-pull-request", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The text of the reply to the review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"pull_request_review_id\":42,\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get rate limit status for the authenticated user", - "scope": "rateLimit", - "id": "get", - "method": "GET", - "url": "/rate_limit", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\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/enterprise-server@3.3/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"resources\":{\"core\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873,\"used\":1},\"search\":{\"limit\":30,\"remaining\":18,\"reset\":1372697452,\"used\":12},\"graphql\":{\"limit\":5000,\"remaining\":4993,\"reset\":1372700389,\"used\":7},\"integration_manifest\":{\"limit\":5000,\"remaining\":4999,\"reset\":1551806725,\"used\":1},\"code_scanning_upload\":{\"limit\":500,\"remaining\":499,\"reset\":1551806725,\"used\":1}},\"rate\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873,\"used\":1}}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create reaction for a commit comment", - "scope": "reactions", - "id": "createForCommitComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#comments). A response with an HTTP `200` status means that you already added the reaction type to this commit comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#create-reaction-for-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the commit comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Reaction exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Reaction created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create reaction for an issue", - "scope": "reactions", - "id": "createForIssue", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to an [issue](https://docs.github.com/enterprise-server@3.3/rest/reference/issues/). A response with an HTTP `200` status means that you already added the reaction type to this issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#create-reaction-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the issue.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create reaction for an issue comment", - "scope": "reactions", - "id": "createForIssueComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.3/rest/reference/issues#comments). A response with an HTTP `200` status means that you already added the reaction type to this issue comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#create-reaction-for-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the issue comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Reaction exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Reaction created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create reaction for a pull request review comment", - "scope": "reactions", - "id": "createForPullRequestReviewComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#comments). A response with an HTTP `200` status means that you already added the reaction type to this pull request review comment.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the pull request review comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Reaction exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Reaction created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create reaction for a release", - "scope": "reactions", - "id": "createForRelease", - "method": "POST", - "url": "/repos/{owner}/{repo}/releases/{release_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [release](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#create-reaction-for-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the release.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["+1", "laugh", "heart", "hooray", "rocket", "eyes"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Reaction exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Reaction created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create reaction for a team discussion comment", - "scope": "reactions", - "id": "createForTeamDiscussionCommentInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#create-reaction-for-a-team-discussion-comment", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response when the reaction type has already been added to this team discussion comment", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create reaction for a team discussion comment (Legacy)", - "scope": "reactions", - "id": "createForTeamDiscussionCommentLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "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/enterprise-server@3.3/rest/reference/reactions#create-reaction-for-a-team-discussion-comment)\" endpoint.\n\nCreate a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create reaction for a team discussion", - "scope": "reactions", - "id": "createForTeamDiscussionInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#create-reaction-for-a-team-discussion", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the team discussion.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create reaction for a team discussion (Legacy)", - "scope": "reactions", - "id": "createForTeamDiscussionLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "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/enterprise-server@3.3/rest/reference/reactions#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#create-reaction-for-a-team-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types) to add to the team discussion.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a commit comment reaction", - "scope": "reactions", - "id": "deleteForCommitComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to a [commit comment](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#delete-a-commit-comment-reaction", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an issue reaction", - "scope": "reactions", - "id": "deleteForIssue", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`.\n\nDelete a reaction to an [issue](https://docs.github.com/enterprise-server@3.3/rest/reference/issues/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#delete-an-issue-reaction", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete an issue comment reaction", - "scope": "reactions", - "id": "deleteForIssueComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`.\n\nDelete a reaction to an [issue comment](https://docs.github.com/enterprise-server@3.3/rest/reference/issues#comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#delete-an-issue-comment-reaction", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a pull request comment reaction", - "scope": "reactions", - "id": "deleteForPullRequestComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.`\n\nDelete a reaction to a [pull request review comment](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#review-comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#delete-a-pull-request-comment-reaction", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a release reaction", - "scope": "reactions", - "id": "deleteForRelease", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`.\n\nDelete a reaction to a [release](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#releases).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#delete-a-release-reaction", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete team discussion reaction", - "scope": "reactions", - "id": "deleteForTeamDiscussion", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#delete-team-discussion-reaction", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete team discussion comment reaction", - "scope": "reactions", - "id": "deleteForTeamDiscussionComment", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#delete-team-discussion-comment-reaction", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a reaction (Legacy)", - "scope": "reactions", - "id": "deleteLegacy", - "method": "DELETE", - "url": "/reactions/{reaction_id}", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#discussion-comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#delete-a-reaction-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "reaction_id", - "description": "The unique identifier of the reaction.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for a commit comment", - "scope": "reactions", - "id": "listForCommitComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [commit comment](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#list-reactions-for-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a commit comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for an issue", - "scope": "reactions", - "id": "listForIssue", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to an [issue](https://docs.github.com/enterprise-server@3.3/rest/reference/issues).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#list-reactions-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "The number that identifies the issue.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 410, "description": "Gone", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for an issue comment", - "scope": "reactions", - "id": "listForIssueComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.3/rest/reference/issues#comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#list-reactions-for-an-issue-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to an issue comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for a pull request review comment", - "scope": "reactions", - "id": "listForPullRequestReviewComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#review-comments).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for a release", - "scope": "reactions", - "id": "listForRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [release](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#releases).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#list-reactions-for-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a release.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["+1", "laugh", "heart", "hooray", "rocket", "eyes"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion comment", - "scope": "reactions", - "id": "listForTeamDiscussionCommentInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#list-reactions-for-a-team-discussion-comment", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion comment (Legacy)", - "scope": "reactions", - "id": "listForTeamDiscussionCommentLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "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/enterprise-server@3.3/rest/reference/reactions#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#discussion-comments). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion", - "scope": "reactions", - "id": "listForTeamDiscussionInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#list-reactions-for-a-team-discussion", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion (Legacy)", - "scope": "reactions", - "id": "listForTeamDiscussionLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "isDeprecated": true, - "deprecationDate": "2020-02-26", - "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/enterprise-server@3.3/rest/reference/reactions#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#list-reactions-for-a-team-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/enterprise-server@3.3/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Accept a repository invitation", - "scope": "repos", - "id": "acceptInvitation", - "method": "PATCH", - "url": "/user/repository_invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/invitations#accept-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null } - ], - "renamed": { - "before": { "scope": "repos", "id": "acceptInvitation" }, - "after": { - "scope": "repos", - "id": "acceptInvitationForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Accept a repository invitation", - "scope": "repos", - "id": "acceptInvitationForAuthenticatedUser", - "method": "PATCH", - "url": "/user/repository_invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/invitations#accept-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null } - ], - "renamed": null - }, - { - "name": "Add app access restrictions", - "scope": "repos", - "id": "addAppAccessRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#add-app-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "apps", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add a repository collaborator", - "scope": "repos", - "id": "addCollaborator", - "method": "PUT", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nFor more information on permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#invitations).\n\n**Updating an existing collaborator's permission level**\n\nThe endpoint can also be used to change the permissions of an existing collaborator without first removing and re-adding the collaborator. To change the permissions, use the same endpoint and pass a different `permission` parameter. The response will be a `204`, with no other indication that the permission level changed.\n\n**Rate limits**\n\nYou are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/collaborators#add-a-repository-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "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": "permission", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response when a new invitation is created", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}" - } - ] - }, - { - "code": 204, - "description": "Response when:\n- an existing collaborator is added as a collaborator\n- an organization member is added as an individual collaborator\n- an existing team member (whose team is also a repository collaborator) is added as an individual collaborator", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add status check contexts", - "scope": "repos", - "id": "addStatusCheckContexts", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#add-status-check-contexts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[\"continuous-integration/travis-ci\",\"continuous-integration/jenkins\"]" - } - ] - }, - { "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": "Add team access restrictions", - "scope": "repos", - "id": "addTeamAccessRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "deprecationDate": 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 teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#add-team-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "teams", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add user access restrictions", - "scope": "repos", - "id": "addUserAccessRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "isDeprecated": false, - "deprecationDate": 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 people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#add-user-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "users", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check if a user is a repository collaborator", - "scope": "repos", - "id": "checkCollaborator", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "Response if user is a collaborator", - "examples": null - }, - { - "code": 404, - "description": "Not Found if user is not a collaborator", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Compare two commits", - "scope": "repos", - "id": "compareCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/compare/{base}...{head}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Deprecated**: Use `repos.compareCommitsWithBasehead()` (`GET /repos/{owner}/{repo}/compare/{basehead}`) instead. Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. 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 response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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\n**Working with large comparisons**\n\nTo process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"[Traversing with pagination](/rest/guides/traversing-with-pagination).\"\n\nWhen calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/rest/reference/repos#compare-two-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/compare/master...topic\",\"html_url\":\"https://github.com/octocat/Hello-World/compare/master...topic\",\"permalink_url\":\"https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17\",\"diff_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.patch\",\"base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"merge_base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"status\":\"behind\",\"ahead_by\":1,\"behind_by\":2,\"total_commits\":1,\"commits\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}],\"files\":[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "Compare two commits", - "scope": "repos", - "id": "compareCommitsWithBasehead", - "method": "GET", - "url": "/repos/{owner}/{repo}/compare/{basehead}", - "isDeprecated": false, - "deprecationDate": null, - "description": "The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.3/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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\n**Working with large comparisons**\n\nTo process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"[Traversing with pagination](/rest/guides/traversing-with-pagination).\"\n\nWhen calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/commits#compare-two-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "basehead", - "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/compare/master...topic\",\"html_url\":\"https://github.com/octocat/Hello-World/compare/master...topic\",\"permalink_url\":\"https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17\",\"diff_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.patch\",\"base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"merge_base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"status\":\"behind\",\"ahead_by\":1,\"behind_by\":2,\"total_commits\":1,\"commits\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}],\"files\":[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Create an autolink reference for a repository", - "scope": "repos", - "id": "createAutolink", - "method": "POST", - "url": "/repos/{owner}/{repo}/autolinks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with admin access to the repository can create an autolink.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/v3/repos#create-an-autolink", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key_prefix", - "description": "The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "url_template", - "description": "The URL must contain `` for the reference number.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "is_alphanumeric", - "description": "Whether this autolink reference matches alphanumeric characters. If true, the `` parameter of the `url_template` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`. If false, this autolink reference only matches numeric characters.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"key_prefix\":\"TICKET-\",\"url_template\":\"https://example.com/TICKET?query=\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a commit comment", - "scope": "repos", - "id": "createCommitComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/comments#create-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "Relative path of the file to comment on.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "Line index in the diff to comment on.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "line", - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author_association\":\"COLLABORATOR\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create commit signature protection", - "scope": "repos", - "id": "createCommitSignatureProtection", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "isDeprecated": false, - "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-commit-signature-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\"enabled\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Create a commit status", - "scope": "repos", - "id": "createCommitStatus", - "method": "POST", - "url": "/repos/{owner}/{repo}/statuses/{sha}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/statuses#create-a-commit-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the status.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["error", "failure", "pending", "success"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_url", - "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the status.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "context", - "description": "A string label to differentiate this status from the status of other systems. This field is case-insensitive.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a deploy key", - "scope": "repos", - "id": "createDeployKey", - "method": "POST", - "url": "/repos/{owner}/{repo}/keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can create a read-only deploy key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-a-deploy-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "A name for the key.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key", - "description": "The contents of the key.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "read_only", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a deployment", - "scope": "repos", - "id": "createDeployment", - "method": "POST", - "url": "/repos/{owner}/{repo}/deployments", - "isDeprecated": false, - "deprecationDate": 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 Enterprise Server 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/enterprise-server@3.3/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-a-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. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The ref to deploy. This can be a branch, tag, or SHA.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "task", - "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_merge", - "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_contexts", - "description": "The [status](https://docs.github.com/enterprise-server@3.3/rest/commits/statuses) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "payload", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "Short description of the deployment.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "transient_environment", - "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false`", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "production_environment", - "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}" - } - ] - }, - { - "code": 202, - "description": "Merged branch response", - "examples": [ - { - "data": "{\"message\":\"Auto-merged master into topic-branch on deployment.\"}" - } - ] - }, - { - "code": 409, - "description": "Conflict when there is a merge conflict or the commit's status checks failed", - "examples": null - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a deployment branch policy", - "scope": "repos", - "id": "createDeploymentBranchPolicy", - "method": "POST", - "url": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/deployments/branch-policies#create-deployment-branch-policy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":364662,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=\",\"name\":\"release/*\"}" - }, - { - "data": "{\"id\":364663,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=\",\"name\":\"main\"}" - } - ] - }, - { - "code": 303, - "description": "Response if the same branch name pattern already exists", - "examples": null - }, - { - "code": 404, - "description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a deployment status", - "scope": "repos", - "id": "createDeploymentStatus", - "method": "POST", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-a-deployment-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "error", - "failure", - "inactive", - "in_progress", - "queued", - "pending", - "success" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_url", - "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "log_url", - "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"`", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the status. The maximum description length is 140 characters.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["production", "staging", "qa"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_url", - "description": "Sets the URL for accessing your environment. Default: `\"\"`", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_inactive", - "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true`", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"https://test-branch.lab.acme.com\",\"log_url\":\"https://example.com/deployment/42/output\"}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a repository dispatch event", - "scope": "repos", - "id": "createDispatchEvent", - "method": "POST", - "url": "/repos/{owner}/{repo}/dispatches", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server 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/enterprise-server@3.3/webhooks/event-payloads/#repository_dispatch).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow.\n\nThis endpoint requires write access to the repository by providing either:\n\n - Personal access tokens with `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-a-repository-dispatch-event", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event_type", - "description": "A custom webhook event name. Must be 100 characters or fewer.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "client_payload", - "description": "JSON payload with extra information about the webhook event that your action or workflow may use.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "client_payload.*", - "description": "", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a repository for the authenticated user", - "scope": "repos", - "id": "createForAuthenticatedUser", - "method": "POST", - "url": "/user/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.3/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-a-repository-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "The name of the repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "homepage", - "description": "A URL with more information about the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Whether the repository is private.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_issues", - "description": "Whether issues are enabled.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_projects", - "description": "Whether projects are enabled.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_wiki", - "description": "Whether the wiki is enabled.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_id", - "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_init", - "description": "Whether the repository is initialized with a minimal README.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "gitignore_template", - "description": "The desired language or platform to apply to the .gitignore.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "license_template", - "description": "The license keyword of the open source license for this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_squash_merge", - "description": "Whether to allow squash merges for pull requests.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_merge_commit", - "description": "Whether to allow merge commits for pull requests.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_rebase_merge", - "description": "Whether to allow rebase merges for pull requests.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_auto_merge", - "description": "Whether to allow Auto-merge to be used on pull requests.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delete_branch_on_merge", - "description": "Whether to delete head branches when pull requests are merged", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "squash_merge_commit_title", - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_TITLE", "COMMIT_OR_PR_TITLE"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "squash_merge_commit_message", - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_BODY", "COMMIT_MESSAGES", "BLANK"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_commit_title", - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_TITLE", "MERGE_MESSAGE"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_commit_message", - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_BODY", "PR_TITLE", "BLANK"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_downloads", - "description": "Whether downloads are enabled.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "is_template", - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "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}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a fork", - "scope": "repos", - "id": "createFork", - "method": "POST", - "url": "/repos/{owner}/{repo}/forks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-a-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. 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": "organization", - "description": "Optional parameter to specify the organization name if forking into an organization.", - "in": "BODY", - "type": "string", - "required": false, - "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\"},\"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,\"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": "Create an organization repository", - "scope": "repos", - "id": "createInOrg", - "method": "POST", - "url": "/orgs/{org}/repos", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/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", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-an-organization-repository", - "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": "name", - "description": "The name of the repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "homepage", - "description": "A URL with more information about the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Whether the repository is private.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["public", "private", "internal"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_issues", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_projects", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_wiki", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "is_template", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_id", - "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_init", - "description": "Pass `true` to create an initial commit with empty README.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "gitignore_template", - "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "license_template", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_squash_merge", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_merge_commit", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_rebase_merge", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_auto_merge", - "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delete_branch_on_merge", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "use_squash_pr_title_as_default", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "squash_merge_commit_title", - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_TITLE", "COMMIT_OR_PR_TITLE"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "squash_merge_commit_message", - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_BODY", "COMMIT_MESSAGES", "BLANK"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_commit_title", - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_TITLE", "MERGE_MESSAGE"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_commit_message", - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_BODY", "PR_TITLE", "BLANK"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "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}" - } - ] - }, - { "code": 403, "description": "Forbidden", "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", - "id": "createOrUpdateEnvironment", - "method": "PUT", - "url": "/repos/{owner}/{repo}/environments/{environment_name}", - "isDeprecated": false, - "deprecationDate": 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 \"[Secrets](/rest/reference/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-or-update-an-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "wait_timer", - "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reviewers", - "description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reviewers[].type", - "description": "The type of reviewer.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["User", "Team"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "reviewers[].id", - "description": "The id of the user or team who can review the deployment", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_branch_policy", - "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_branch_policy.protected_branches", - "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_branch_policy.custom_branch_policies", - "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\",\"protection_rules\":[{\"id\":3736,\"node_id\":\"MDQ6R2F0ZTM3MzY=\",\"type\":\"wait_timer\",\"wait_timer\":30},{\"id\":3755,\"node_id\":\"MDQ6R2F0ZTM3NTU=\",\"type\":\"required_reviewers\",\"reviewers\":[{\"type\":\"User\",\"reviewer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}},{\"type\":\"Team\",\"reviewer\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]},{\"id\":3756,\"node_id\":\"MDQ6R2F0ZTM3NTY=\",\"type\":\"branch_policy\"}],\"deployment_branch_policy\":{\"protected_branches\":false,\"custom_branch_policies\":true}}" - } - ] - }, - { - "code": 422, - "description": "Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create or update file contents", - "scope": "repos", - "id": "createOrUpdateFileContents", - "method": "PUT", - "url": "/repos/{owner}/{repo}/contents/{path}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/enterprise-server@3.3/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-or-update-file-contents", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "path parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The commit message.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The new file content, using Base64 encoding.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer", - "description": "The person that committed the file. Default: the authenticated user.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.name", - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.email", - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.date", - "description": "", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author", - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.name", - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.email", - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.date", - "description": "", - "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": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"a56507ed892d05a37c6d6128c260937ea4d287bd\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"node_id\":\"MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\",\"sha\":\"9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6\",\"sha\":\"da5a433788da5c255edad7979b328b67d79f53f6\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a GitHub Enterprise Server Pages site", - "scope": "repos", - "id": "createPagesSite", - "method": "POST", - "url": "/repos/{owner}/{repo}/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "Configures a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/pages#create-a-github-pages-site", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "build_type", - "description": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["legacy", "workflow"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source", - "description": "The source branch and directory used to publish your Pages site.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source.branch", - "description": "The repository branch used to publish your site's source files.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source.path", - "description": "The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/`", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["/", "/docs"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages\",\"status\":\"built\",\"cname\":\"developer.github.com\",\"custom_404\":false,\"html_url\":\"https://developer.github.com\",\"source\":{\"branch\":\"master\",\"path\":\"/\"},\"public\":true,\"https_certificate\":{\"state\":\"approved\",\"description\":\"Certificate is approved\",\"domains\":[\"developer.github.com\"],\"expires_at\":\"2021-05-22\"},\"https_enforced\":true}" - } - ] - }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a release", - "scope": "repos", - "id": "createRelease", - "method": "POST", - "url": "/repos/{owner}/{repo}/releases", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag_name", - "description": "The name of the tag.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_commitish", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the release.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "Text describing the contents of the tag.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "draft", - "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "prerelease", - "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "generate_release_notes", - "description": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a repository using a template", - "scope": "repos", - "id": "createUsingTemplate", - "method": "POST", - "url": "/repos/{template_owner}/{template_repo}/generate", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/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/enterprise-server@3.3/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", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-a-repository-using-a-template", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "template_owner", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "template_repo", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the new repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the new repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "include_all_branches", - "description": "Set to `true` to include the directory structure and files from all branches in the template repository, and not just the default branch. Default: `false`.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Either `true` to create a new private repository or `false` to create a new public one.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "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\"}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a repository webhook", - "scope": "repos", - "id": "createWebhook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can\nshare the same `config` as long as those webhooks do not have any `events` that overlap.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repos#create-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-hook-config-params).", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "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/enterprise-server@3.3/webhooks/event-payloads) the hook is triggered for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"deliveries_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":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": "Decline a repository invitation", - "scope": "repos", - "id": "declineInvitation", - "method": "DELETE", - "url": "/user/repository_invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/invitations#decline-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null } - ], - "renamed": { - "before": { "scope": "repos", "id": "declineInvitation" }, - "after": { - "scope": "repos", - "id": "declineInvitationForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Decline a repository invitation", - "scope": "repos", - "id": "declineInvitationForAuthenticatedUser", - "method": "DELETE", - "url": "/user/repository_invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/invitations#decline-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a repository", - "scope": "repos", - "id": "delete", - "method": "DELETE", - "url": "/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 307, "description": "Temporary Redirect", "examples": null }, - { - "code": 403, - "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", - "examples": [ - { - "data": "{\"message\":\"Organization members cannot delete repositories.\",\"documentation_url\":\"https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-a-repository\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete access restrictions", - "scope": "repos", - "id": "deleteAccessRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "isDeprecated": false, - "deprecationDate": 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\nDisables the ability to restrict who can push to this branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete admin branch protection", - "scope": "repos", - "id": "deleteAdminBranchProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "isDeprecated": false, - "deprecationDate": 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\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-admin-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an environment", - "scope": "repos", - "id": "deleteAnEnvironment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/environments/{environment_name}", - "isDeprecated": false, - "deprecationDate": null, - "description": "You must authenticate using an access token with the repo scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-an-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Default response", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete an autolink reference from a repository", - "scope": "repos", - "id": "deleteAutolink", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/autolinks/{autolink_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "This deletes a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/v3/repos#delete-autolink", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "autolink_id", - "description": "The unique identifier of the autolink.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete branch protection", - "scope": "repos", - "id": "deleteBranchProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a commit comment", - "scope": "repos", - "id": "deleteCommitComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/comments#delete-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete commit signature protection", - "scope": "repos", - "id": "deleteCommitSignatureProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "isDeprecated": false, - "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-commit-signature-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a deploy key", - "scope": "repos", - "id": "deleteDeployKey", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-a-deploy-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "The unique identifier of the key.", - "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 a deployment", - "scope": "repos", - "id": "deleteDeployment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-a-deployment-status).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-a-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. 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": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a deployment branch policy", - "scope": "repos", - "id": "deleteDeploymentBranchPolicy", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/deployments/branch-policies#delete-deployment-branch-policy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch_policy_id", - "description": "The unique identifier of the branch policy.", - "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 a file", - "scope": "repos", - "id": "deleteFile", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/contents/{path}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/enterprise-server@3.3/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-a-file", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "path parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The commit message.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "The blob SHA of the file being deleted.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer", - "description": "object containing information about the committer.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.email", - "description": "The email of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author", - "description": "object containing information about the author.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.email", - "description": "The email of the author (or committer) of the commit", - "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": "{\"content\":null,\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a repository invitation", - "scope": "repos", - "id": "deleteInvitation", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/invitations#delete-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "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 a GitHub Enterprise Server Pages site", - "scope": "repos", - "id": "deletePagesSite", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/pages#delete-a-github-pages-site", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete pull request review protection", - "scope": "repos", - "id": "deletePullRequestReviewProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-pull-request-review-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Delete a release", - "scope": "repos", - "id": "deleteRelease", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access to the repository can delete a release.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a release asset", - "scope": "repos", - "id": "deleteReleaseAsset", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#delete-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "asset_id", - "description": "The unique identifier of the asset.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a repository webhook", - "scope": "repos", - "id": "deleteWebhook", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repos#delete-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Disable Git LFS for a repository", - "scope": "repos", - "id": "disableLfsForRepo", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/lfs", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#disable-git-lfs-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Download a repository archive (tar)", - "scope": "repos", - "id": "downloadTarballArchive", - "method": "GET", - "url": "/repos/{owner}/{repo}/tarball/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#download-a-repository-archive", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Download a repository archive (zip)", - "scope": "repos", - "id": "downloadZipballArchive", - "method": "GET", - "url": "/repos/{owner}/{repo}/zipball/{ref}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#download-a-repository-archive", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 302, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Enable Git LFS for a repository", - "scope": "repos", - "id": "enableLfsForRepo", - "method": "PUT", - "url": "/repos/{owner}/{repo}/lfs", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#enable-git-lfs-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, - { - "code": 403, - "description": "We will return a 403 with one of the following messages:\n\n- Git LFS support not enabled because Git LFS is globally disabled.\n- Git LFS support not enabled because Git LFS is disabled for the root repository in the network.\n- Git LFS support not enabled because Git LFS is disabled for .", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Generate release notes content for a release", - "scope": "repos", - "id": "generateReleaseNotes", - "method": "POST", - "url": "/repos/{owner}/{repo}/releases/generate-notes", - "isDeprecated": false, - "deprecationDate": null, - "description": "Generate a name and body describing a [release](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#generate-release-notes", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag_name", - "description": "The tag name for the release. This can be an existing tag or a new one.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_commitish", - "description": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "previous_tag_name", - "description": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "configuration_file_path", - "description": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Name and body of generated release notes", - "examples": [ - { - "data": "{\"name\":\"Release v1.0.0 is now available!\",\"body\":\"##Changes in Release v1.0.0 ... ##Contributors @monalisa\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a repository", - "scope": "repos", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":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\":{\"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}}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get access restrictions", - "scope": "repos", - "id": "getAccessRestrictions", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - "isDeprecated": false, - "deprecationDate": 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 who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get admin branch protection", - "scope": "repos", - "id": "getAdminBranchProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-admin-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List environments", - "scope": "repos", - "id": "getAllEnvironments", - "method": "GET", - "url": "/repos/{owner}/{repo}/environments", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/deployments/environments#list-environments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"environments\":[{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\",\"protection_rules\":[{\"id\":3736,\"node_id\":\"MDQ6R2F0ZTM3MzY=\",\"type\":\"wait_timer\",\"wait_timer\":30},{\"id\":3755,\"node_id\":\"MDQ6R2F0ZTM3NTU=\",\"type\":\"required_reviewers\",\"reviewers\":[{\"type\":\"User\",\"reviewer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}},{\"type\":\"Team\",\"reviewer\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]},{\"id\":3756,\"node_id\":\"MDQ6R2F0ZTM3NTY=\",\"type\":\"branch_policy\"}],\"deployment_branch_policy\":{\"protected_branches\":false,\"custom_branch_policies\":true}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get all status check contexts", - "scope": "repos", - "id": "getAllStatusCheckContexts", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-all-status-check-contexts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all repository topics", - "scope": "repos", - "id": "getAllTopics", - "method": "GET", - "url": "/repos/{owner}/{repo}/topics", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-all-repository-topics", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get apps with access to the protected branch", - "scope": "repos", - "id": "getAppsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-apps-with-access-to-the-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an autolink reference of a repository", - "scope": "repos", - "id": "getAutolink", - "method": "GET", - "url": "/repos/{owner}/{repo}/autolinks/{autolink_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "This returns a single autolink reference by ID that was configured for the given repository.\n\nInformation about autolinks are only available to repository administrators.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/v3/repos#get-autolink", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "autolink_id", - "description": "The unique identifier of the autolink.", - "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\":1,\"key_prefix\":\"TICKET-\",\"url_template\":\"https://example.com/TICKET?query=\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a branch", - "scope": "repos", - "id": "getBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"main\",\"commit\":{\"sha\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"node_id\":\"MDY6Q29tbWl0MTI5NjI2OTo3ZmQxYTYwYjAxZjkxYjMxNGY1OTk1NWE0ZTRkNGU4MGQ4ZWRmMTFk\",\"commit\":{\"author\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\",\"date\":\"2012-03-06T23:06:50Z\"},\"committer\":{\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\",\"date\":\"2012-03-06T23:06:50Z\"},\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"tree\":{\"sha\":\"b4eecafa9be2f2006ce1b709d6857b07069b4608\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608\"},\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"comment_count\":77,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments\",\"author\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"sha\":\"553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\"},{\"sha\":\"762941318ee16e59dabbacb1b4049eec22f0d303\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/762941318ee16e59dabbacb1b4049eec22f0d303\"}]},\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/branches/main\",\"html\":\"https://github.com/octocat/Hello-World/tree/main\"},\"protected\":false,\"protection\":{\"enabled\":false,\"required_status_checks\":{\"enforcement_level\":\"off\",\"contexts\":[],\"checks\":[]}},\"protection_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/main/protection\"}" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get branch protection", - "scope": "repos", - "id": "getBranchProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\",\"enforcement_level\":\"non_admins\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/apps\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true},\"required_conversation_resolution\":{\"enabled\":true}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the weekly commit activity", - "scope": "repos", - "id": "getCodeFrequencyStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/code_frequency", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/metrics/statistics#get-the-weekly-commit-activity", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", - "examples": [{ "data": "[[1302998400,1124,-435]]" }] - }, - { "code": 202, "description": "Accepted", "examples": null }, - { - "code": 204, - "description": "A header with no content is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get repository permissions for a user", - "scope": "repos", - "id": "getCollaboratorPermissionLevel", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "isDeprecated": false, - "deprecationDate": null, - "description": "Checks the repository permission of a collaborator. The possible repository permissions are `admin`, `write`, `read`, and `none`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/collaborators#get-repository-permissions-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. 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 - } - ], - "responses": [ - { - "code": 200, - "description": "if user has admin permissions", - "examples": [ - { - "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the combined status for a specific reference", - "scope": "repos", - "id": "getCombinedStatusForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/status", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/statuses#get-the-combined-status-for-a-specific-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"state\":\"success\",\"statuses\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\"},{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"id\":2,\"node_id\":\"MDY6U3RhdHVzMg==\",\"state\":\"success\",\"description\":\"Testing has completed successfully\",\"target_url\":\"https://ci.example.com/2000/output\",\"context\":\"security/brakeman\",\"created_at\":\"2012-08-20T01:19:13Z\",\"updated_at\":\"2012-08-20T01:19:13Z\"}],\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"total_count\":2,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a commit", - "scope": "repos", - "id": "getCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/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/enterprise-server@3.3/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 her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/commits#get-a-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}],\"stats\":{\"additions\":104,\"deletions\":4,\"total\":108},\"files\":[{\"filename\":\"file1.txt\",\"additions\":10,\"deletions\":2,\"changes\":12,\"status\":\"modified\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"blob_url\":\"https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"patch\":\"@@ -29,7 +29,7 @@\\n.....\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 500, "description": "Internal Error", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the last year of commit activity", - "scope": "repos", - "id": "getCommitActivityStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/commit_activity", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/metrics/statistics#get-the-last-year-of-commit-activity", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"days\":[0,3,26,20,39,1,0],\"total\":89,\"week\":1336280400}]" - } - ] - }, - { "code": 202, "description": "Accepted", "examples": null }, - { - "code": 204, - "description": "A header with no content is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a commit comment", - "scope": "repos", - "id": "getCommitComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/comments#get-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author_association\":\"COLLABORATOR\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get commit signature protection", - "scope": "repos", - "id": "getCommitSignatureProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - "isDeprecated": false, - "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-commit-signature-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\"enabled\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get repository content", - "scope": "repos", - "id": "getContent", - "method": "GET", - "url": "/repos/{owner}/{repo}/contents/{path}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/repos#custom-media-types) for\nretrieving the raw content or rendered HTML (when supported). All content types support [a custom media\ntype](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#custom-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/enterprise-server@3.3/rest/reference/git#trees).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees\nAPI](https://docs.github.com/enterprise-server@3.3/rest/reference/git#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* This API supports files up to 1 megabyte in size.\n\n#### If the content is a directory\nThe response will be an array of objects, one object for each item in the directory.\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value\n_should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major version of the API, the type will be returned as \"submodule\".\n\n#### If the content is a symlink \nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the\nAPI responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object \ndescribing the symlink itself.\n\n#### If the content is a submodule\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific\ncommit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out\nthe submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-repository-content", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "path parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": null }, - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" - }, - { - "data": "[{\"type\":\"file\",\"size\":625,\"name\":\"octokit.rb\",\"path\":\"lib/octokit.rb\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb\",\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"octokit\",\"path\":\"lib/octokit\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\"}}]" - }, - { - "data": "{\"type\":\"symlink\",\"target\":\"/path/to/symlink/target\",\"size\":23,\"name\":\"some-symlink\",\"path\":\"bin/some-symlink\",\"sha\":\"452a98979c88e093d682cab404a3ec82babebb48\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\"}}" - }, - { - "data": "{\"type\":\"submodule\",\"submodule_git_url\":\"git://github.com/jquery/qunit.git\",\"size\":0,\"name\":\"qunit\",\"path\":\"test/qunit\",\"sha\":\"6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"url\":\"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\"git_url\":\"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"html_url\":\"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"download_url\":null,\"_links\":{\"git\":\"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"self\":\"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\"html\":\"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\"}}" - } - ] - }, - { "code": 302, "description": "Found", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get all contributor commit activity", - "scope": "repos", - "id": "getContributorsStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/contributors", - "isDeprecated": false, - "deprecationDate": 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", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/metrics/statistics#get-all-contributor-commit-activity", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"total\":135,\"weeks\":[{\"w\":1367712000,\"a\":6898,\"d\":77,\"c\":10}]}]" - } - ] - }, - { "code": 202, "description": "Accepted", "examples": null }, - { - "code": 204, - "description": "A header with no content is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a deploy key", - "scope": "repos", - "id": "getDeployKey", - "method": "GET", - "url": "/repos/{owner}/{repo}/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-deploy-key", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key_id", - "description": "The unique identifier of the key.", - "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\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a deployment", - "scope": "repos", - "id": "getDeployment", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-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. 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": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a deployment branch policy", - "scope": "repos", - "id": "getDeploymentBranchPolicy", - "method": "GET", - "url": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/deployments/branch-policies#get-deployment-branch-policy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch_policy_id", - "description": "The unique identifier of the branch policy.", - "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\":364662,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=\",\"name\":\"release/*\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a deployment status", - "scope": "repos", - "id": "getDeploymentStatus", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with pull access can view a deployment status for a deployment:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-deployment-status", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"https://test-branch.lab.acme.com\",\"log_url\":\"https://example.com/deployment/42/output\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get an environment", - "scope": "repos", - "id": "getEnvironment", - "method": "GET", - "url": "/repos/{owner}/{repo}/environments/{environment_name}", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-an-environment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":161088068,\"node_id\":\"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\"name\":\"staging\",\"url\":\"https://api.github.com/repos/github/hello-world/environments/staging\",\"html_url\":\"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\"created_at\":\"2020-11-23T22:00:40Z\",\"updated_at\":\"2020-11-23T22:00:40Z\",\"protection_rules\":[{\"id\":3736,\"node_id\":\"MDQ6R2F0ZTM3MzY=\",\"type\":\"wait_timer\",\"wait_timer\":30},{\"id\":3755,\"node_id\":\"MDQ6R2F0ZTM3NTU=\",\"type\":\"required_reviewers\",\"reviewers\":[{\"type\":\"User\",\"reviewer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}},{\"type\":\"Team\",\"reviewer\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}}]},{\"id\":3756,\"node_id\":\"MDQ6R2F0ZTM3NTY=\",\"type\":\"branch_policy\"}],\"deployment_branch_policy\":{\"protected_branches\":false,\"custom_branch_policies\":true}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get latest Pages build", - "scope": "repos", - "id": "getLatestPagesBuild", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds/latest", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/pages#get-latest-pages-build", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the latest release", - "scope": "repos", - "id": "getLatestRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/latest", - "isDeprecated": false, - "deprecationDate": null, - "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-the-latest-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/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}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a GitHub Enterprise Server Pages site", - "scope": "repos", - "id": "getPages", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/pages#get-a-github-pages-site", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages\",\"status\":\"built\",\"cname\":\"developer.github.com\",\"custom_404\":false,\"html_url\":\"https://developer.github.com\",\"source\":{\"branch\":\"master\",\"path\":\"/\"},\"public\":true,\"https_certificate\":{\"state\":\"approved\",\"description\":\"Certificate is approved\",\"domains\":[\"developer.github.com\"],\"expires_at\":\"2021-05-22\"},\"https_enforced\":true}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get GitHub Enterprise Server Pages build", - "scope": "repos", - "id": "getPagesBuild", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds/{build_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/pages#get-github-pages-build", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "build_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the weekly commit count", - "scope": "repos", - "id": "getParticipationStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/participation", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/metrics/statistics#get-the-weekly-commit-count", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The array order is oldest week (index 0) to most recent week.", - "examples": [ - { - "data": "{\"all\":[11,21,15,2,8,1,8,23,17,21,11,10,33,91,38,34,22,23,32,3,43,87,71,18,13,5,13,16,66,27,12,45,110,117,13,8,18,9,19,26,39,12,20,31,46,91,45,10,24,9,29,7],\"owner\":[3,2,3,0,2,0,5,14,7,9,1,5,0,48,19,2,0,1,10,2,23,40,35,8,8,2,10,6,30,0,2,9,53,104,3,3,10,4,7,11,21,4,4,22,26,63,11,2,14,1,10,3]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get pull request review protection", - "scope": "repos", - "id": "getPullRequestReviewProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-pull-request-review-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the hourly commit count for each day", - "scope": "repos", - "id": "getPunchCardStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/punch_card", - "isDeprecated": false, - "deprecationDate": null, - "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/statistics/repos#get-the-hourly-commit-count-for-each-day", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", - "examples": [{ "data": "[[0,0,5],[0,1,43],[0,2,21]]" }] - }, - { - "code": 204, - "description": "A header with no content is returned.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a repository README", - "scope": "repos", - "id": "getReadme", - "method": "GET", - "url": "/repos/{owner}/{repo}/readme", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-repository-readme", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a repository README for a directory", - "scope": "repos", - "id": "getReadmeInDirectory", - "method": "GET", - "url": "/repos/{owner}/{repo}/readme/{dir}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-repository-directory-readme", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dir", - "description": "The alternate path to look for a README file", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a release", - "scope": "repos", - "id": "getRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "isDeprecated": false, - "deprecationDate": null, - "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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#hypermedia).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#hypermedia).", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a release asset", - "scope": "repos", - "id": "getReleaseAsset", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.3/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "asset_id", - "description": "The unique identifier of the asset.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { "code": 302, "description": "Found", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a release by tag name", - "scope": "repos", - "id": "getReleaseByTag", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/tags/{tag}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get a published release with the specified tag.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-a-release-by-tag-name", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag", - "description": "tag parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"discussion_url\":\"https://github.com/octocat/Hello-World/discussions/90\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get status checks protection", - "scope": "repos", - "id": "getStatusChecksProtection", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#get-status-checks-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get teams with access to the protected branch", - "scope": "repos", - "id": "getTeamsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "deprecationDate": 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 teams who have push access to this branch. The list includes child teams.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-teams-with-access-to-the-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get users with access to the protected branch", - "scope": "repos", - "id": "getUsersWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "isDeprecated": false, - "deprecationDate": 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 people who have push access to this branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-users-with-access-to-the-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a repository webhook", - "scope": "repos", - "id": "getWebhook", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a webhook configured in a repository. To get only the webhook `config` properties, see \"[Get a webhook configuration for a repository](/rest/reference/repos#get-a-webhook-configuration-for-a-repository).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repos#get-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"deliveries_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a webhook configuration for a repository", - "scope": "repos", - "id": "getWebhookConfigForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "isDeprecated": false, - "deprecationDate": 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/reference/orgs#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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a delivery for a repository webhook", - "scope": "repos", - "id": "getWebhookDelivery", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a delivery for a webhook configured in a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delivery_id", - "description": "", - "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\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456,\"url\":\"https://www.example.com\",\"request\":{\"headers\":{\"X-GitHub-Delivery\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"X-Hub-Signature-256\":\"sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"Accept\":\"*/*\",\"X-GitHub-Hook-ID\":\"42\",\"User-Agent\":\"GitHub-Hookshot/b8c71d8\",\"X-GitHub-Event\":\"issues\",\"X-GitHub-Hook-Installation-Target-ID\":\"123\",\"X-GitHub-Hook-Installation-Target-Type\":\"repository\",\"content-type\":\"application/json\",\"X-Hub-Signature\":\"sha1=a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\"},\"payload\":{\"action\":\"opened\",\"issue\":{\"body\":\"foo\"},\"repository\":{\"id\":123}}},\"response\":{\"headers\":{\"Content-Type\":\"text/html;charset=utf-8\"},\"payload\":\"ok\"}}" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List all autolinks of a repository", - "scope": "repos", - "id": "listAutolinks", - "method": "GET", - "url": "/repos/{owner}/{repo}/autolinks", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/v3/repos#list-autolinks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"key_prefix\":\"TICKET-\",\"url_template\":\"https://example.com/TICKET?query=\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List branches", - "scope": "repos", - "id": "listBranches", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-branches", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "protected", - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"name\":\"master\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"protected\":true,\"protection\":{\"required_status_checks\":{\"enforcement_level\":\"non_admins\",\"contexts\":[\"ci-test\",\"linter\"]}},\"protection_url\":\"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List branches for HEAD commit", - "scope": "repos", - "id": "listBranchesForHeadCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - "isDeprecated": false, - "deprecationDate": 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\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/commits#list-branches-for-head-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit.", - "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\":\"branch_5\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"protected\":false}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List repository collaborators", - "scope": "repos", - "id": "listCollaborators", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/collaborators#list-repository-collaborators", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "affiliation", - "description": "Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` means all collaborators with permissions to an organization-owned repository, regardless of organization membership status. `all` means all collaborators the authenticated user can see.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["outside", "direct", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["pull", "triage", "push", "maintain", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"permissions\":{\"pull\":true,\"push\":true,\"admin\":false}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List commit comments", - "scope": "repos", - "id": "listCommentsForCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Use the `:commit_sha` to specify the commit that will have its comments listed.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/comments#list-commit-comments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List commit comments for a repository", - "scope": "repos", - "id": "listCommitCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Commit Comments use [these custom media types](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#custom-media-types). You can read more about the use of media types in the API [here](https://docs.github.com/enterprise-server@3.3/rest/overview/media-types/).\n\nComments are ordered by ascending ID.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/comments#list-commit-comments-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"author_association\":\"COLLABORATOR\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List commit statuses for a reference", - "scope": "repos", - "id": "listCommitStatusesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/statuses", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/statuses#list-commit-statuses-for-a-reference", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" - } - ] - }, - { "code": 301, "description": "Moved permanently", "examples": null } - ], - "renamed": null - }, - { - "name": "List commits", - "scope": "repos", - "id": "listCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/commits#list-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "path", - "description": "Only commits containing this file path will be returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author", - "description": "GitHub login or email address by which to filter by commit author.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}]" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { "code": 500, "description": "Internal Error", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository contributors", - "scope": "repos", - "id": "listContributors", - "method": "GET", - "url": "/repos/{owner}/{repo}/contributors", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-repository-contributors", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "anon", - "description": "Set to `1` or `true` to include anonymous contributors in results.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if repository contains content", - "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,\"contributions\":32}]" - } - ] - }, - { - "code": 204, - "description": "Response if repository is empty", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List deploy keys", - "scope": "repos", - "id": "listDeployKeys", - "method": "GET", - "url": "/repos/{owner}/{repo}/keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-deploy-keys", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 200, "description": "Response", "examples": [{ "data": "{}" }] } - ], - "renamed": null - }, - { - "name": "List deployment branch policies", - "scope": "repos", - "id": "listDeploymentBranchPolicies", - "method": "GET", - "url": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/deployments/branch-policies#list-deployment-branch-policies", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"branch_policies\":[{\"id\":361471,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=\",\"name\":\"release/*\"},{\"id\":361472,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=\",\"name\":\"main\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List deployment statuses", - "scope": "repos", - "id": "listDeploymentStatuses", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with pull access can view deployment statuses for a deployment:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-deployment-statuses", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"https://test-branch.lab.acme.com\",\"log_url\":\"https://example.com/deployment/42/output\"}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List deployments", - "scope": "repos", - "id": "listDeployments", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Simple filtering of deployments is available via query parameters:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-deployments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "The SHA recorded at creation time.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the ref. This can be a branch, tag, or SHA.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "task", - "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment", - "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories for the authenticated user", - "scope": "repos", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists repositories 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-repositories-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "visibility", - "description": "Limit results to repositories with the specified visibility.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "public", "private"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "affiliation", - "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "type", - "description": "Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "owner", "public", "private", "member"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "pushed", "full_name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List organization repositories", - "scope": "repos", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists repositories for the specified organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-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": "type", - "description": "Specifies the types of repositories you want returned. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "all", - "public", - "private", - "forks", - "sources", - "member", - "internal" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "pushed", "full_name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories for a user", - "scope": "repos", - "id": "listForUser", - "method": "GET", - "url": "/users/{username}/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-repositories-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "type", - "description": "Limit results to repositories of the specified type.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "owner", "member"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The property to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "pushed", "full_name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List forks", - "scope": "repos", - "id": "listForks", - "method": "GET", - "url": "/repos/{owner}/{repo}/forks", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-forks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The sort order. `stargazers` will sort by star count.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["newest", "oldest", "stargazers", "watchers"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":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\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"delete_branch_on_merge\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository invitations", - "scope": "repos", - "id": "listInvitations", - "method": "GET", - "url": "/repos/{owner}/{repo}/invitations", - "isDeprecated": false, - "deprecationDate": null, - "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/invitations#list-repository-invitations", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\",\"node_id\":\"MDQ6VXNlcjE=\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository invitations for the authenticated user", - "scope": "repos", - "id": "listInvitationsForAuthenticatedUser", - "method": "GET", - "url": "/user/repository_invitations", - "isDeprecated": false, - "deprecationDate": null, - "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\",\"node_id\":\"MDQ6VXNlcjE=\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository languages", - "scope": "repos", - "id": "listLanguages", - "method": "GET", - "url": "/repos/{owner}/{repo}/languages", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-repository-languages", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "{\"C\":78769,\"Python\":7769}" }] - } - ], - "renamed": null - }, - { - "name": "List GitHub Enterprise Server Pages builds", - "scope": "repos", - "id": "listPagesBuilds", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/pages#list-github-pages-builds", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public repositories", - "scope": "repos", - "id": "listPublic", - "method": "GET", - "url": "/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-public-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "A repository ID. Only return repositories with an ID greater than this ID.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Specifies the types of repositories to return. This endpoint will only list repositories available to all users on the enterprise.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "public"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List pull requests associated with a commit", - "scope": "repos", - "id": "listPullRequestsAssociatedWithCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/commits#list-pull-requests-associated-with-a-commit", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_sha", - "description": "The SHA of the commit.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List release assets", - "scope": "repos", - "id": "listReleaseAssets", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-release-assets", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/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}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List releases", - "scope": "repos", - "id": "listReleases", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases", - "isDeprecated": false, - "deprecationDate": null, - "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-repository-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-releases", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/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\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List repository tags", - "scope": "repos", - "id": "listTags", - "method": "GET", - "url": "/repos/{owner}/{repo}/tags", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-repository-tags", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"name\":\"v0.1\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"zipball_url\":\"https://github.com/octocat/Hello-World/zipball/v0.1\",\"tarball_url\":\"https://github.com/octocat/Hello-World/tarball/v0.1\",\"node_id\":\"MDQ6VXNlcjE=\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repository teams", - "scope": "repos", - "id": "listTeams", - "method": "GET", - "url": "/repos/{owner}/{repo}/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-repository-teams", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List deliveries for a repository webhook", - "scope": "repos", - "id": "listWebhookDeliveries", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a list of webhook deliveries for a webhook configured in a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "cursor", - "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":12345678,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-03T00:57:16Z\",\"redelivery\":false,\"duration\":0.27,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456},{\"id\":123456789,\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"delivered_at\":\"2019-06-04T00:57:16Z\",\"redelivery\":true,\"duration\":0.28,\"status\":\"OK\",\"status_code\":200,\"event\":\"issues\",\"action\":\"opened\",\"installation_id\":123,\"repository_id\":456}]" - } - ] - }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "List repository webhooks", - "scope": "repos", - "id": "listWebhooks", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repos#list-repository-webhooks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"deliveries_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Merge a branch", - "scope": "repos", - "id": "merge", - "method": "POST", - "url": "/repos/{owner}/{repo}/merges", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#merge-a-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "The name of the base branch that the head will be merged into.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "The head to merge. This can be a branch name or a commit SHA1.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_message", - "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Successful Response (The resulting merge commit)", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"mona@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"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},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}],\"stats\":{\"additions\":104,\"deletions\":4,\"total\":108},\"files\":[{\"filename\":\"file1.txt\",\"additions\":10,\"deletions\":2,\"changes\":12,\"status\":\"modified\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"blob_url\":\"https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"patch\":\"@@ -29,7 +29,7 @@\\n.....\"}]}" - } - ] - }, - { - "code": 204, - "description": "Response when already merged", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found when the base or head does not exist", - "examples": null - }, - { - "code": 409, - "description": "Conflict when there is a merge conflict", - "examples": null - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Sync a fork branch with the upstream repository", - "scope": "repos", - "id": "mergeUpstream", - "method": "POST", - "url": "/repos/{owner}/{repo}/merge-upstream", - "isDeprecated": false, - "deprecationDate": null, - "description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch which should be updated to match upstream.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "The branch has been successfully synced with the upstream repository", - "examples": [ - { - "data": "{\"message\":\"Successfully fetched and fast-forwarded from upstream defunkt:main\",\"merge_type\":\"fast-forward\",\"base_branch\":\"defunkt:main\"}" - } - ] - }, - { - "code": 409, - "description": "The branch could not be synced because of a merge conflict", - "examples": null - }, - { - "code": 422, - "description": "The branch could not be synced for some other reason", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Ping a repository webhook", - "scope": "repos", - "id": "pingWebhook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "isDeprecated": false, - "deprecationDate": null, - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.3/webhooks/#ping-event) to be sent to the hook.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repos#ping-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Redeliver a delivery for a repository webhook", - "scope": "repos", - "id": "redeliverWebhookDelivery", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Redeliver a webhook delivery for a webhook configured in a repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delivery_id", - "description": "", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove app access restrictions", - "scope": "repos", - "id": "removeAppAccessRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#remove-app-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "apps", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove a repository collaborator", - "scope": "repos", - "id": "removeCollaborator", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/collaborators#remove-a-repository-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove status check contexts", - "scope": "repos", - "id": "removeStatusCheckContexts", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#remove-status-check-contexts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove status check protection", - "scope": "repos", - "id": "removeStatusCheckProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#remove-status-check-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove team access restrictions", - "scope": "repos", - "id": "removeTeamAccessRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "deprecationDate": 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 a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#remove-team-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "teams", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove user access restrictions", - "scope": "repos", - "id": "removeUserAccessRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "isDeprecated": false, - "deprecationDate": 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 a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#remove-user-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "users", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Rename a branch", - "scope": "repos", - "id": "renameBranch", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/rename", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#rename-a-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "new_name", - "description": "The new name of the branch.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"name\":\"master\",\"commit\":{\"sha\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"node_id\":\"MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==\",\"commit\":{\"author\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"tree\":{\"sha\":\"b4eecafa9be2f2006ce1b709d6857b07069b4608\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608\"},\"committer\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null},\"comment_count\":0},\"author\":{\"gravatar_id\":\"\",\"avatar_url\":\"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png\",\"url\":\"https://api.github.com/users/octocat\",\"id\":583231,\"login\":\"octocat\",\"node_id\":\"MDQ6VXNlcjE=\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"parents\":[{\"sha\":\"553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\"},{\"sha\":\"762941318ee16e59dabbacb1b4049eec22f0d303\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303\"}],\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"committer\":{\"gravatar_id\":\"\",\"avatar_url\":\"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png\",\"url\":\"https://api.github.com/users/octocat\",\"id\":583231,\"login\":\"octocat\",\"node_id\":\"MDQ6VXNlcjE=\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\"},\"_links\":{\"html\":\"https://github.com/octocat/Hello-World/tree/master\",\"self\":\"https://api.github.com/repos/octocat/Hello-World/branches/master\"},\"protected\":true,\"protection\":{\"required_status_checks\":{\"enforcement_level\":\"non_admins\",\"contexts\":[\"ci-test\",\"linter\"]}},\"protection_url\":\"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"}" - } - ] - }, - { "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": "Replace all repository topics", - "scope": "repos", - "id": "replaceAllTopics", - "method": "PUT", - "url": "/repos/{owner}/{repo}/topics", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#replace-all-repository-topics", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "names", - "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Request a GitHub Enterprise Server Pages build", - "scope": "repos", - "id": "requestPagesBuild", - "method": "POST", - "url": "/repos/{owner}/{repo}/pages/builds", - "isDeprecated": false, - "deprecationDate": null, - "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/pages#request-a-github-pages-build", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/latest\",\"status\":\"queued\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set admin branch protection", - "scope": "repos", - "id": "setAdminBranchProtection", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "isDeprecated": false, - "deprecationDate": 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\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#set-admin-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set app access restrictions", - "scope": "repos", - "id": "setAppAccessRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#set-app-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "apps", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":true},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Set status check contexts", - "scope": "repos", - "id": "setStatusCheckContexts", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#set-status-check-contexts", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Set team access restrictions", - "scope": "repos", - "id": "setTeamAccessRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "deprecationDate": 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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#set-team-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "teams", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Set user access restrictions", - "scope": "repos", - "id": "setUserAccessRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - "isDeprecated": false, - "deprecationDate": 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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#set-user-access-restrictions", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "users", - "description": "", - "in": "BODY", - "type": null, - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Test the push repository webhook", - "scope": "repos", - "id": "testPushWebhook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", - "isDeprecated": false, - "deprecationDate": null, - "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repos#test-the-push-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Transfer a repository", - "scope": "repos", - "id": "transfer", - "method": "POST", - "url": "/repos/{owner}/{repo}/transfer", - "isDeprecated": false, - "deprecationDate": 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/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#transfer-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "new_owner", - "description": "The username or organization name the repository will be transferred to.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_ids", - "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "in": "BODY", - "type": "integer[]", - "required": false, - "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\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"allow_forking\":true,\"subscribers_count\":42,\"network_count\":0}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a repository", - "scope": "repos", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#replace-all-repository-topics) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos/#update-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "homepage", - "description": "A URL with more information about the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["public", "private", "internal"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis", - "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.3/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.advanced_security", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.advanced_security.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning", - "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning_push_protection", - "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning_push_protection.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_issues", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_projects", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_wiki", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "is_template", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "default_branch", - "description": "Updates the default branch for this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_squash_merge", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_merge_commit", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_rebase_merge", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_auto_merge", - "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delete_branch_on_merge", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_update_branch", - "description": "Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "use_squash_pr_title_as_default", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "squash_merge_commit_title", - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_TITLE", "COMMIT_OR_PR_TITLE"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "squash_merge_commit_message", - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_BODY", "COMMIT_MESSAGES", "BLANK"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_commit_title", - "description": "The default value for a merge commit title.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_TITLE", "MERGE_MESSAGE"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "merge_commit_message", - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["PR_BODY", "PR_TITLE", "BLANK"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "archived", - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_forking", - "description": "Either `true` to allow private forks, or `false` to prevent private forks.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://github.com/licenses/mit\"},\"forks_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,\"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": 307, "description": "Temporary Redirect", "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": "Update branch protection", - "scope": "repos", - "id": "updateBranchProtection", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", - "isDeprecated": false, - "deprecationDate": 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\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-branch-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks", - "description": "Require status checks to pass before merging. Set to `null` to disable.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.strict", - "description": "Require branches to be up to date before merging.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.contexts", - "description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.checks", - "description": "The list of status checks to require in order to merge into this branch.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.checks[].context", - "description": "The name of the required check", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.checks[].app_id", - "description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "enforce_admins", - "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews", - "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismissal_restrictions", - "description": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismissal_restrictions.users", - "description": "The list of user `login`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismissal_restrictions.teams", - "description": "The list of team `slug`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismissal_restrictions.apps", - "description": "The list of app `slug`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismiss_stale_reviews", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.required_approving_review_count", - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "restrictions", - "description": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "restrictions.users", - "description": "The list of user `login`s with push access", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "restrictions.teams", - "description": "The list of team `slug`s with push access", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "restrictions.apps", - "description": "The list of app `slug`s with push access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_linear_history", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_force_pushes", - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_deletions", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "block_creations", - "description": "If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_conversation_resolution", - "description": "Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "The list of status checks to require in order to merge into this branch.", - "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": "{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts\",\"checks\":[{\"context\":\"continuous-integration/travis-ci\",\"app_id\":null}]},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps\",\"users\":[],\"teams\":[],\"apps\":[]},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews\",\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2,\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams\",\"users\":[],\"teams\":[],\"apps\":[]}},\"required_signatures\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures\",\"enabled\":false},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins\",\"enabled\":true},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true},\"block_creations\":{\"enabled\":true},\"required_conversation_resolution\":{\"enabled\":true}}" - } - ] - }, - { "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": "Update a commit comment", - "scope": "repos", - "id": "updateCommitComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/commits/comments#update-a-commit-comment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_id", - "description": "The unique identifier of the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Nice change\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author_association\":\"COLLABORATOR\",\"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},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a deployment branch policy", - "scope": "repos", - "id": "updateDeploymentBranchPolicy", - "method": "PUT", - "url": "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/deployments/branch-policies#update-deployment-branch-policy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "environment_name", - "description": "The name of the environment.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch_policy_id", - "description": "The unique identifier of the branch policy.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":364662,\"node_id\":\"MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=\",\"name\":\"release/*\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update information about a GitHub Enterprise Server Pages site", - "scope": "repos", - "id": "updateInformationAboutPagesSite", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pages", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/pages#update-information-about-a-github-pages-site", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "cname", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "https_enforced", - "description": "Specify whether HTTPS should be enforced for the repository.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "public", - "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "build_type", - "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["legacy", "workflow"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 400, "description": "Bad Request", "examples": null }, - { "code": 409, "description": "Conflict", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a repository invitation", - "scope": "repos", - "id": "updateInvitation", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/collaborators/invitations#update-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "invitation_id", - "description": "The unique identifier of the invitation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permissions", - "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "maintain", "triage", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"expired\":false,\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update pull request review protection", - "scope": "repos", - "id": "updatePullRequestReviewProtection", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - "isDeprecated": false, - "deprecationDate": 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\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-pull-request-review-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissal_restrictions", - "description": "Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissal_restrictions.users", - "description": "The list of user `login`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissal_restrictions.teams", - "description": "The list of team `slug`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismissal_restrictions.apps", - "description": "The list of app `slug`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "dismiss_stale_reviews", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_approving_review_count", - "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" - } - ] - }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a release", - "scope": "repos", - "id": "updateRelease", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/releases/{release_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access to the repository can edit a release.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-a-release", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tag_name", - "description": "The name of the tag.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_commitish", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the release.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "Text describing the contents of the tag.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "draft", - "description": "`true` makes the release a draft, and `false` publishes the release.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "prerelease", - "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/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}}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a release asset", - "scope": "repos", - "id": "updateReleaseAsset", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Users with push access to the repository can edit a release asset.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "asset_id", - "description": "The unique identifier of the asset.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The file name of the asset.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "label", - "description": "An alternate short description of the asset. Used in place of the filename.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "", - "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": "{\"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}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update status check protection", - "scope": "repos", - "id": "updateStatusCheckProtection", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - "isDeprecated": false, - "deprecationDate": 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\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#update-status-check-protection", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "The name of the branch.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "strict", - "description": "Require branches to be up to date before merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "contexts", - "description": "The list of status checks to require in order to merge into this branch", - "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": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Update a repository webhook", - "scope": "repos", - "id": "updateWebhook", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for a repository](/rest/reference/repos#update-a-webhook-configuration-for-a-repository).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repos#update-a-repository-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-hook-config-params).", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "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/enterprise-server@3.3/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "add_events", - "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "remove_events", - "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"deliveries_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":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": "Update a webhook configuration for a repository", - "scope": "repos", - "id": "updateWebhookConfigForRepo", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/config", - "isDeprecated": false, - "deprecationDate": 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/reference/orgs#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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#delivery-headers).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "insecure_ssl", - "description": "", - "in": "BODY", - "type": null, - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\",\"url\":\"https://example.com/webhook\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Upload a release asset", - "scope": "repos", - "id": "uploadReleaseAsset", - "method": "POST", - "url": "{origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint makes use of [a Hypermedia relation](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/reference/repos#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 Enterprise Server 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 Enterprise Server renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://docs.github.com/enterprise-server@3.3/rest/reference/repos#list-assets-for-a-release)\"\nendpoint lists the renamed filenames. For more information and help, contact [GitHub Enterprise Server Support](https://support.github.com/contact?tags=dotcom-rest-api).\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/enterprise-server@3.3/rest/reference/repos#upload-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "release_id", - "description": "The unique identifier of the release.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "label", - "description": "", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "data", - "description": "The raw file data", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint", - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response for successful upload", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - }, - { - "code": 422, - "description": "Response if you upload an asset with the same filename as another uploaded asset", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Search code", - "scope": "search", - "id": "code", - "method": "GET", - "url": "/search/code", - "isDeprecated": false, - "deprecationDate": null, - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/reference/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\n#### Considerations 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/search#search-code", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.3/rest/reference/search#constructing-a-search-query). See \"[Searching code](https://docs.github.com/enterprise-server@3.3/search-github/searching-on-github/searching-code)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.3/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["indexed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":7,\"incomplete_results\":false,\"items\":[{\"name\":\"classes.js\",\"path\":\"src/attributes/classes.js\",\"sha\":\"d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\"url\":\"https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4\",\"git_url\":\"https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\"html_url\":\"https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js\",\"repository\":{\"id\":167174,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxNjcxNzQ=\",\"name\":\"jquery\",\"full_name\":\"jquery/jquery\",\"owner\":{\"login\":\"jquery\",\"id\":70142,\"node_id\":\"MDQ6VXNlcjcwMTQy\",\"avatar_url\":\"https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/jquery\",\"html_url\":\"https://github.com/jquery\",\"followers_url\":\"https://api.github.com/users/jquery/followers\",\"following_url\":\"https://api.github.com/users/jquery/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/jquery/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/jquery/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/jquery/subscriptions\",\"organizations_url\":\"https://api.github.com/users/jquery/orgs\",\"repos_url\":\"https://api.github.com/users/jquery/repos\",\"events_url\":\"https://api.github.com/users/jquery/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/jquery/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/jquery/jquery\",\"description\":\"jQuery JavaScript Library\",\"fork\":false,\"url\":\"https://api.github.com/repos/jquery/jquery\",\"forks_url\":\"https://api.github.com/repos/jquery/jquery/forks\",\"keys_url\":\"https://api.github.com/repos/jquery/jquery/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/jquery/jquery/teams\",\"hooks_url\":\"https://api.github.com/repos/jquery/jquery/hooks\",\"issue_events_url\":\"https://api.github.com/repos/jquery/jquery/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/jquery/jquery/events\",\"assignees_url\":\"https://api.github.com/repos/jquery/jquery/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/jquery/jquery/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/jquery/jquery/tags\",\"blobs_url\":\"https://api.github.com/repos/jquery/jquery/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/jquery/jquery/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/jquery/jquery/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/jquery/jquery/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/jquery/jquery/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/jquery/jquery/languages\",\"stargazers_url\":\"https://api.github.com/repos/jquery/jquery/stargazers\",\"contributors_url\":\"https://api.github.com/repos/jquery/jquery/contributors\",\"subscribers_url\":\"https://api.github.com/repos/jquery/jquery/subscribers\",\"subscription_url\":\"https://api.github.com/repos/jquery/jquery/subscription\",\"commits_url\":\"https://api.github.com/repos/jquery/jquery/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/jquery/jquery/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/jquery/jquery/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/jquery/jquery/issues/comments/{number}\",\"contents_url\":\"https://api.github.com/repos/jquery/jquery/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/jquery/jquery/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/jquery/jquery/merges\",\"archive_url\":\"https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/jquery/jquery/downloads\",\"issues_url\":\"https://api.github.com/repos/jquery/jquery/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/jquery/jquery/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/jquery/jquery/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/jquery/jquery/labels{/name}\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\"},\"score\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Search commits", - "scope": "search", - "id": "commits", - "method": "GET", - "url": "/search/commits", - "isDeprecated": false, - "deprecationDate": null, - "description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/reference/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/enterprise-server@3.3/rest/reference/search#search-commits", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.3/rest/reference/search#constructing-a-search-query). See \"[Searching commits](https://docs.github.com/enterprise-server@3.3/search-github/searching-on-github/searching-commits)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://docs.github.com/enterprise-server@3.3/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["author-date", "committer-date"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":1,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"sha\":\"bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"author\":{\"date\":\"2014-02-04T14:38:36-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"date\":\"2014-02-12T15:18:55-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"message\":\"Create styles.css and updated README\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68\",\"sha\":\"a639e96f9038797fba6e0469f94a4b0cc459fa68\"},\"comment_count\":8},\"author\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"sha\":\"a30c19e3f13765a3b48829788bc1cb8b4e95cee4\"}],\"repository\":{\"id\":1300192,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMzAwMTky\",\"name\":\"Spoon-Knife\",\"full_name\":\"octocat/Spoon-Knife\",\"owner\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Spoon-Knife\",\"description\":\"This repo is for demonstration purposes only.\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife\",\"forks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/forks\",\"keys_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/teams\",\"hooks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/events\",\"assignees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/tags\",\"blobs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/languages\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscription\",\"commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/merges\",\"archive_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/downloads\",\"issues_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/deployments\"},\"score\":1,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\"}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Search issues and pull requests", - "scope": "search", - "id": "issuesAndPullRequests", - "method": "GET", - "url": "/search/issues", - "isDeprecated": false, - "deprecationDate": null, - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/search#search-issues-and-pull-requests", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.3/rest/reference/search#constructing-a-search-query). See \"[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.3/search-github/searching-on-github/searching-issues-and-pull-requests)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://docs.github.com/enterprise-server@3.3/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":280,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132\",\"repository_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit\",\"labels_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments\",\"events_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events\",\"html_url\":\"https://github.com/batterseapower/pinyin-toolkit/issues/132\",\"id\":35802,\"node_id\":\"MDU6SXNzdWUzNTgwMg==\",\"number\":132,\"title\":\"Line Number Indexes Beyond 20 Not Displayed\",\"user\":{\"login\":\"Nick3C\",\"id\":90254,\"node_id\":\"MDQ6VXNlcjkwMjU0\",\"avatar_url\":\"https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/Nick3C\",\"html_url\":\"https://github.com/Nick3C\",\"followers_url\":\"https://api.github.com/users/Nick3C/followers\",\"following_url\":\"https://api.github.com/users/Nick3C/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/Nick3C/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/Nick3C/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/Nick3C/subscriptions\",\"organizations_url\":\"https://api.github.com/users/Nick3C/orgs\",\"repos_url\":\"https://api.github.com/users/Nick3C/repos\",\"events_url\":\"https://api.github.com/users/Nick3C/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/Nick3C/received_events\",\"type\":\"User\",\"site_admin\":true},\"labels\":[{\"id\":4,\"node_id\":\"MDU6TGFiZWw0\",\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug\",\"name\":\"bug\",\"color\":\"ff0000\"}],\"state\":\"open\",\"assignee\":null,\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"comments\":15,\"created_at\":\"2009-07-12T20:10:41Z\",\"updated_at\":\"2009-07-19T09:23:43Z\",\"closed_at\":null,\"pull_request\":{\"url\":\"https://api/github.com/repos/octocat/Hello-World/pull/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"body\":\"...\",\"score\":1,\"locked\":true,\"author_association\":\"COLLABORATOR\",\"state_reason\":\"completed\"}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Search labels", - "scope": "search", - "id": "labels", - "method": "GET", - "url": "/search/labels", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/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/enterprise-server@3.3/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\n`q=bug+defect+enhancement&repository_id=64778136`\n\nThe labels that best match the query appear first in the search results.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/search#search-labels", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "repository_id", - "description": "The id of the repository.", - "in": "QUERY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.3/rest/reference/search#constructing-a-search-query).", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.3/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":2,\"incomplete_results\":false,\"items\":[{\"id\":418327088,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODg=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/enhancement\",\"name\":\"enhancement\",\"color\":\"84b6eb\",\"default\":true,\"description\":\"New feature or request.\",\"score\":1},{\"id\":418327086,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODY=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/bug\",\"name\":\"bug\",\"color\":\"ee0701\",\"default\":true,\"description\":\"Something isn't working.\",\"score\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 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": "Search repositories", - "scope": "search", - "id": "repos", - "method": "GET", - "url": "/search/repositories", - "isDeprecated": false, - "deprecationDate": null, - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for popular Tetris repositories written in assembly code, your query might look like this:\n\n`q=tetris+language:assembly&sort=stars&order=desc`\n\nThis query searches for repositories with the word `tetris` in the name, the description, or the README. The results are limited to repositories where the primary language is assembly. The results are sorted by stars in descending order, so that the most popular repositories appear first in the search results.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/search#search-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.3/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://docs.github.com/enterprise-server@3.3/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["stars", "forks", "help-wanted-issues", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":40,\"incomplete_results\":false,\"items\":[{\"id\":3081286,\"node_id\":\"MDEwOlJlcG9zaXRvcnkzMDgxMjg2\",\"name\":\"Tetris\",\"full_name\":\"dtrupenn/Tetris\",\"owner\":{\"login\":\"dtrupenn\",\"id\":872147,\"node_id\":\"MDQ6VXNlcjg3MjE0Nw==\",\"avatar_url\":\"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/dtrupenn\",\"received_events_url\":\"https://api.github.com/users/dtrupenn/received_events\",\"type\":\"User\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"site_admin\":true},\"private\":false,\"html_url\":\"https://github.com/dtrupenn/Tetris\",\"description\":\"A C implementation of Tetris using Pennsim through LC4\",\"fork\":false,\"url\":\"https://api.github.com/repos/dtrupenn/Tetris\",\"created_at\":\"2012-01-01T00:31:50Z\",\"updated_at\":\"2013-01-05T17:58:47Z\",\"pushed_at\":\"2012-01-01T00:37:02Z\",\"homepage\":\"https://github.com\",\"size\":524,\"stargazers_count\":1,\"watchers_count\":1,\"language\":\"Assembly\",\"forks_count\":0,\"open_issues_count\":0,\"master_branch\":\"master\",\"default_branch\":\"master\",\"score\":1,\"archive_url\":\"https://api.github.com/repos/dtrupenn/Tetris/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/dtrupenn/Tetris/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/dtrupenn/Tetris/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/dtrupenn/Tetris/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/dtrupenn/Tetris/contributors\",\"deployments_url\":\"https://api.github.com/repos/dtrupenn/Tetris/deployments\",\"downloads_url\":\"https://api.github.com/repos/dtrupenn/Tetris/downloads\",\"events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/events\",\"forks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/forks\",\"git_commits_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/tags{/sha}\",\"git_url\":\"git:github.com/dtrupenn/Tetris.git\",\"issue_comment_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/dtrupenn/Tetris/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/dtrupenn/Tetris/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/dtrupenn/Tetris/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/dtrupenn/Tetris/languages\",\"merges_url\":\"https://api.github.com/repos/dtrupenn/Tetris/merges\",\"milestones_url\":\"https://api.github.com/repos/dtrupenn/Tetris/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/dtrupenn/Tetris/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/dtrupenn/Tetris/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/dtrupenn/Tetris/releases{/id}\",\"ssh_url\":\"git@github.com:dtrupenn/Tetris.git\",\"stargazers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/stargazers\",\"statuses_url\":\"https://api.github.com/repos/dtrupenn/Tetris/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscribers\",\"subscription_url\":\"https://api.github.com/repos/dtrupenn/Tetris/subscription\",\"tags_url\":\"https://api.github.com/repos/dtrupenn/Tetris/tags\",\"teams_url\":\"https://api.github.com/repos/dtrupenn/Tetris/teams\",\"trees_url\":\"https://api.github.com/repos/dtrupenn/Tetris/git/trees{/sha}\",\"clone_url\":\"https://github.com/dtrupenn/Tetris.git\",\"mirror_url\":\"git:git.example.com/dtrupenn/Tetris\",\"hooks_url\":\"https://api.github.com/repos/dtrupenn/Tetris/hooks\",\"svn_url\":\"https://svn.github.com/dtrupenn/Tetris\",\"forks\":1,\"open_issues\":1,\"watchers\":1,\"has_issues\":true,\"has_projects\":true,\"has_pages\":true,\"has_wiki\":true,\"has_downloads\":true,\"archived\":true,\"disabled\":true,\"visibility\":\"private\",\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"}}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Search topics", - "scope": "search", - "id": "topics", - "method": "GET", - "url": "/search/topics", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/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/enterprise-server@3.3/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/search#search-topics", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.3/rest/reference/search#constructing-a-search-query).", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":6,\"incomplete_results\":false,\"items\":[{\"name\":\"ruby\",\"display_name\":\"Ruby\",\"short_description\":\"Ruby is a scripting language designed for simplified object-oriented programming.\",\"description\":\"Ruby was developed by Yukihiro \\\"Matz\\\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.\",\"created_by\":\"Yukihiro Matsumoto\",\"released\":\"December 21, 1995\",\"created_at\":\"2016-11-28T22:03:59Z\",\"updated_at\":\"2017-10-30T18:16:32Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"rails\",\"display_name\":\"Rails\",\"short_description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby.\",\"description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.\",\"created_by\":\"David Heinemeier Hansson\",\"released\":\"December 13 2005\",\"created_at\":\"2016-12-09T17:03:50Z\",\"updated_at\":\"2017-10-30T16:20:19Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"python\",\"display_name\":\"Python\",\"short_description\":\"Python is a dynamically typed programming language.\",\"description\":\"Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.\",\"created_by\":\"Guido van Rossum\",\"released\":\"February 20, 1991\",\"created_at\":\"2016-12-07T00:07:02Z\",\"updated_at\":\"2017-10-27T22:45:43Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"jekyll\",\"display_name\":\"Jekyll\",\"short_description\":\"Jekyll is a simple, blog-aware static site generator.\",\"description\":\"Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.\",\"created_by\":\"Tom Preston-Werner\",\"released\":\"2008\",\"created_at\":\"2016-12-16T21:53:08Z\",\"updated_at\":\"2017-10-27T19:00:24Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"sass\",\"display_name\":\"Sass\",\"short_description\":\"Sass is a stable extension to classic CSS.\",\"description\":\"Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.\",\"created_by\":\"Hampton Catlin, Natalie Weizenbaum, Chris Eppstein\",\"released\":\"November 28, 2006\",\"created_at\":\"2016-12-16T21:53:45Z\",\"updated_at\":\"2018-01-16T16:30:40Z\",\"featured\":true,\"curated\":true,\"score\":1},{\"name\":\"homebrew\",\"display_name\":\"Homebrew\",\"short_description\":\"Homebrew is a package manager for macOS.\",\"description\":\"Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.\",\"created_by\":\"Max Howell\",\"released\":\"2009\",\"created_at\":\"2016-12-17T20:30:44Z\",\"updated_at\":\"2018-02-06T16:14:56Z\",\"featured\":true,\"curated\":true,\"score\":1}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "Search users", - "scope": "search", - "id": "users", - "method": "GET", - "url": "/search/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/reference/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.3/rest/reference/search#text-match-metadata).\n\nFor example, if you're looking for a list of popular users, you might try this query:\n\n`q=tom+repos:%3E42+followers:%3E1000`\n\nThis query searches for users with the name `tom`. The results are restricted to users with more than 42 repositories and over 1,000 followers.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/search#search-users", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.3/rest/reference/search#constructing-a-search-query). See \"[Searching users](https://docs.github.com/enterprise-server@3.3/search-github/searching-on-github/searching-users)\" for a detailed list of qualifiers.", - "in": "QUERY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://docs.github.com/enterprise-server@3.3/rest/reference/search#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["followers", "repositories", "joined"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"total_count\":12,\"incomplete_results\":false,\"items\":[{\"login\":\"mojombo\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/mojombo\",\"html_url\":\"https://github.com/mojombo\",\"followers_url\":\"https://api.github.com/users/mojombo/followers\",\"subscriptions_url\":\"https://api.github.com/users/mojombo/subscriptions\",\"organizations_url\":\"https://api.github.com/users/mojombo/orgs\",\"repos_url\":\"https://api.github.com/users/mojombo/repos\",\"received_events_url\":\"https://api.github.com/users/mojombo/received_events\",\"type\":\"User\",\"score\":1,\"following_url\":\"https://api.github.com/users/mojombo/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/mojombo/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/mojombo/starred{/owner}{/repo}\",\"events_url\":\"https://api.github.com/users/mojombo/events{/privacy}\",\"site_admin\":true}]}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a secret scanning alert", - "scope": "secretScanning", - "id": "getAlert", - "method": "GET", - "url": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/secret-scanning#get-a-secret-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"number\":42,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/42\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations\",\"state\":\"open\",\"secret_type\":\"mailchimp_api_key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 404, - "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List secret scanning alerts for an organization", - "scope": "secretScanning", - "id": "listAlertsForOrg", - "method": "GET", - "url": "/orgs/{org}/secret-scanning/alerts", - "isDeprecated": false, - "deprecationDate": 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.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/secret-scanning#list-secret-scanning-alerts-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "resolved"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_type", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "resolution", - "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"number\":2,\"created_at\":\"2020-11-06T18:48:51Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/2\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations\",\"state\":\"resolved\",\"resolution\":\"false_positive\",\"resolved_at\":\"2020-11-07T02:47:13Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"adafruit_io_key\",\"secret_type_display_name\":\"Adafruit IO Key\",\"secret\":\"aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"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}\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\"},\"push_protection_bypassed_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"push_protection_bypassed\":true,\"push_protection_bypassed_at\":\"2020-11-06T21:48:51Z\"},{\"number\":1,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/repo/secret-scanning/alerts/1\",\"html_url\":\"https://github.com/owner/repo/security/secret-scanning/1\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations\",\"state\":\"open\",\"resolution\":null,\"resolved_at\":null,\"resolved_by\":null,\"secret_type\":\"mailchimp_api_key\",\"secret_type_display_name\":\"Mailchimp API Key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"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}\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\"},\"push_protection_bypassed_by\":null,\"push_protection_bypassed\":false,\"push_protection_bypassed_at\":null}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List secret scanning alerts for a repository", - "scope": "secretScanning", - "id": "listAlertsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/secret-scanning/alerts", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/secret-scanning#list-secret-scanning-alerts-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Set to `open` or `resolved` to only list secret scanning alerts in a specific state.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "resolved"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "secret_type", - "description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/enterprise-server@3.3/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "resolution", - "description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"number\":2,\"created_at\":\"2020-11-06T18:48:51Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/2\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/2/locations\",\"state\":\"resolved\",\"resolution\":\"false_positive\",\"resolved_at\":\"2020-11-07T02:47:13Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"adafruit_io_key\",\"secret_type_display_name\":\"Adafruit IO Key\",\"secret\":\"aio_XXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\"push_protection_bypassed_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"push_protection_bypassed\":true,\"push_protection_bypassed_at\":\"2020-11-06T21:48:51Z\"},{\"number\":1,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/repo/secret-scanning/alerts/1\",\"html_url\":\"https://github.com/owner/repo/security/secret-scanning/1\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations\",\"state\":\"open\",\"resolution\":null,\"resolved_at\":null,\"resolved_by\":null,\"secret_type\":\"mailchimp_api_key\",\"secret_type_display_name\":\"Mailchimp API Key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\",\"push_protection_bypassed_by\":null,\"push_protection_bypassed\":false,\"push_protection_bypassed_at\":null}]" - } - ] - }, - { - "code": 404, - "description": "Repository is public or secret scanning is disabled for the repository", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "List locations for a secret scanning alert", - "scope": "secretScanning", - "id": "listLocationsForAlert", - "method": "GET", - "url": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/secret-scanning#list-locations-for-a-secret-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"type\":\"commit\",\"details\":{\"path\":\"/example/secrets.txt\",\"start_line\":1,\"end_line\":1,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"blob_url\":\"https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b\",\"commit_sha\":\"f14d7debf9775f957cf4f1e8176da0786431f72b\",\"commit_url\":\"https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b\"}},{\"type\":\"commit\",\"details\":{\"path\":\"/example/secrets.txt\",\"start_line\":5,\"end_line\":5,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"9def38117ab2d8355b982429aa924e268b4b0065\",\"blob_url\":\"https://api.github.com/repos/octocat/hello-world/git/blobs/9def38117ab2d8355b982429aa924e268b4b0065\",\"commit_sha\":\"588483b99a46342501d99e3f10630cfc1219ea32\",\"commit_url\":\"https://api.github.com/repos/octocat/hello-world/git/commits/588483b99a46342501d99e3f10630cfc1219ea32\"}},{\"type\":\"commit\",\"details\":{\"path\":\"/example/secrets.txt\",\"start_line\":12,\"end_line\":12,\"start_column\":1,\"end_column\":64,\"blob_sha\":\"0b33e9c66e19f7fb15137a82ff1c04c10cba6caf\",\"blob_url\":\"https://api.github.com/repos/octocat/hello-world/git/blobs/0b33e9c66e19f7fb15137a82ff1c04c10cba6caf\",\"commit_sha\":\"9def38117ab2d8355b982429aa924e268b4b0065\",\"commit_url\":\"https://api.github.com/repos/octocat/hello-world/git/commits/9def38117ab2d8355b982429aa924e268b4b0065\"}}]" - } - ] - }, - { - "code": 404, - "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Update a secret scanning alert", - "scope": "secretScanning", - "id": "updateAlert", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the `repo` scope or `security_events` scope.\n\nGitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/secret-scanning#update-a-secret-scanning-alert", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "alert_number", - "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["open", "resolved"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "resolution", - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "in": "BODY", - "type": "string", - "required": false, - "enum": [ - null, - "false_positive", - "wont_fix", - "revoked", - "used_in_tests" - ], - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"number\":42,\"created_at\":\"2020-11-06T18:18:30Z\",\"url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42\",\"html_url\":\"https://github.com/owner/private-repo/security/secret-scanning/42\",\"locations_url\":\"https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations\",\"state\":\"resolved\",\"resolution\":\"used_in_tests\",\"resolved_at\":\"2020-11-16T22:42:07Z\",\"resolved_by\":{\"login\":\"monalisa\",\"id\":2,\"node_id\":\"MDQ6VXNlcjI=\",\"avatar_url\":\"https://alambic.github.com/avatars/u/2?\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"secret_type\":\"mailchimp_api_key\",\"secret\":\"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2\"}" - } - ] - }, - { - "code": 404, - "description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found", - "examples": null - }, - { - "code": 422, - "description": "State does not match the resolution", - "examples": null - }, - { "code": 503, "description": "Service unavailable", "examples": null } - ], - "renamed": null - }, - { - "name": "Add team member (Legacy)", - "scope": "teams", - "id": "addMemberLegacy", - "method": "PUT", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-21", - "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/enterprise-server@3.3/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#add-team-member-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "Not Found if team synchronization is set up", - "examples": null - }, - { - "code": 422, - "description": "Unprocessable Entity if you attempt to add an organization to a team or you attempt to add a user to a team when they are not a member of at least one other team in the same organization", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add or update team membership for a user", - "scope": "teams", - "id": "addOrUpdateMembershipForUserInOrg", - "method": "PUT", - "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#add-or-update-team-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": "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": "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 that this user should have in the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["member", "maintainer"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" - } - ] - }, - { - "code": 403, - "description": "Forbidden if team synchronization is set up", - "examples": null - }, - { - "code": 422, - "description": "Unprocessable Entity if you attempt to add an organization to a team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add or update team membership for a user (Legacy)", - "scope": "teams", - "id": "addOrUpdateMembershipForUserLegacy", - "method": "PUT", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "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 that this user should have in the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["member", "maintainer"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" - } - ] - }, - { - "code": 403, - "description": "Forbidden if team synchronization is set up", - "examples": null - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Unprocessable Entity if you attempt to add an organization to a team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add or update team project permissions", - "scope": "teams", - "id": "addOrUpdateProjectPermissionsInOrg", - "method": "PUT", - "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\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}/projects/{project_id}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#add-or-update-team-project-permissions", - "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": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 403, - "description": "Forbidden if the project is not owned by the organization", - "examples": [ - { - "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://docs.github.com/enterprise-server@3.3/rest/reference/teams#add-or-update-team-project-permissions\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add or update team project permissions (Legacy)", - "scope": "teams", - "id": "addOrUpdateProjectPermissionsLegacy", - "method": "PUT", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Add or update team project permissions](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#add-or-update-team-project-permissions) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#add-or-update-team-project-permissions-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 403, - "description": "Forbidden if the project is not owned by the organization", - "examples": [ - { - "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://docs.github.com/enterprise-server@3.3/rest/reference/teams#add-or-update-team-project-permissions\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Add or update team repository permissions", - "scope": "teams", - "id": "addOrUpdateRepoPermissionsInOrg", - "method": "PUT", - "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#add-or-update-team-repository-permissions", - "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": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Add or update team repository permissions (Legacy)", - "scope": "teams", - "id": "addOrUpdateRepoPermissionsLegacy", - "method": "PUT", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.3/rest/reference/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/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#add-or-update-team-repository-permissions-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check team permissions for a project", - "scope": "teams", - "id": "checkPermissionsForProjectInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\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}/projects/{project_id}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#check-team-permissions-for-a-project", - "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": "project_id", - "description": "The unique identifier of the project.", - "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": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}" - } - ] - }, - { - "code": 404, - "description": "Not Found if project is not managed by this team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check team permissions for a project (Legacy)", - "scope": "teams", - "id": "checkPermissionsForProjectLegacy", - "method": "GET", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Check team permissions for a project](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#check-team-permissions-for-a-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#check-team-permissions-for-a-project-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "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": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}" - } - ] - }, - { - "code": 404, - "description": "Not Found if project is not managed by this team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check team permissions for a repository", - "scope": "teams", - "id": "checkPermissionsForRepoInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#check-team-permissions-for-a-repository", - "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": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Alternative response with repository permissions", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"maintain\":false,\"push\":false,\"triage\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"triage\":false,\"push\":false,\"maintain\":false,\"admin\":false},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}" - } - ] - }, - { - "code": 204, - "description": "Response if team has permission for the repository. This is the response when the repository media type hasn't been provded in the Accept header.", - "examples": null - }, - { - "code": 404, - "description": "Not Found if team does not have permission for the repository", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check team permissions for a repository (Legacy)", - "scope": "teams", - "id": "checkPermissionsForRepoLegacy", - "method": "GET", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "deprecationDate": "2020-01-21", - "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**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 [Check team permissions for a repository](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#check-team-permissions-for-a-repository) endpoint.\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/enterprise-server@3.3/rest/overview/media-types/) via the `Accept` header:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#check-team-permissions-for-a-repository-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Alternative response with extra repository information", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"maintain\":false,\"push\":false,\"triage\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World-Template\",\"full_name\":\"octocat/Hello-World-Template\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World-Template\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World-Template\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World-Template.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World-Template.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World-Template.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World-Template\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World-Template\",\"homepage\":\"https://github.com\",\"language\":null,\"forks\":9,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"watchers\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues\":0,\"open_issues_count\":0,\"is_template\":true,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"pull\":true,\"triage\":false,\"push\":false,\"maintain\":false,\"admin\":false},\"allow_rebase_merge\":true,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_auto_merge\":false,\"delete_branch_on_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"https://api.github.com/licenses/mit\"},\"forks\":1,\"open_issues\":1,\"watchers\":1}" - } - ] - }, - { - "code": 204, - "description": "Response if repository is managed by this team", - "examples": null - }, - { - "code": 404, - "description": "Not Found if repository is not managed by this team", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a team", - "scope": "teams", - "id": "create", - "method": "POST", - "url": "/orgs/{org}/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#create-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": "name", - "description": "The name of the team.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "maintainers", - "description": "List GitHub IDs for organization members who will become team maintainers.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo_names", - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "privacy", - "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["secret", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ldap_dn", - "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. LDAP synchronization must be enabled to map LDAP entries to a team. Use the \"[Update LDAP mapping for a team](https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#update-ldap-mapping-for-a-team)\" endpoint to change the LDAP DN. For more information, see \"[Using LDAP](https://docs.github.com/enterprise-server@3.3/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync).\"", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a discussion comment", - "scope": "teams", - "id": "createDiscussionCommentInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#create-a-discussion-comment", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a discussion comment (Legacy)", - "scope": "teams", - "id": "createDiscussionCommentLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "isDeprecated": true, - "deprecationDate": "2020-01-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 a discussion comment](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#create-a-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a discussion", - "scope": "teams", - "id": "createDiscussionInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions", - "isDeprecated": false, - "deprecationDate": null, - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#create-a-discussion", - "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": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion post's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a discussion (Legacy)", - "scope": "teams", - "id": "createDiscussionLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions", - "isDeprecated": true, - "deprecationDate": "2020-01-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 a discussion`](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#create-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion post's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a discussion comment", - "scope": "teams", - "id": "deleteDiscussionCommentInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#delete-a-discussion-comment", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a discussion comment (Legacy)", - "scope": "teams", - "id": "deleteDiscussionCommentLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Delete a discussion comment](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#delete-a-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a discussion", - "scope": "teams", - "id": "deleteDiscussionInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#delete-a-discussion", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a discussion (Legacy)", - "scope": "teams", - "id": "deleteDiscussionLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [`Delete a discussion`](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#delete-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Delete a team", - "scope": "teams", - "id": "deleteInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}", - "isDeprecated": false, - "deprecationDate": null, - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#delete-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": "Delete a team (Legacy)", - "scope": "teams", - "id": "deleteLegacy", - "method": "DELETE", - "url": "/teams/{team_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Delete a team](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#delete-a-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#delete-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a team by name", - "scope": "teams", - "id": "getByName", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Gets a team using the team's `slug`. GitHub Enterprise Server generates the `slug` from the team `name`.\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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-a-team-by-name", - "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": 200, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a discussion comment", - "scope": "teams", - "id": "getDiscussionCommentInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-a-discussion-comment", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a discussion comment (Legacy)", - "scope": "teams", - "id": "getDiscussionCommentLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Get a discussion comment](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-a-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a discussion", - "scope": "teams", - "id": "getDiscussionInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-a-discussion", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a discussion (Legacy)", - "scope": "teams", - "id": "getDiscussionLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Get a discussion](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a team (Legacy)", - "scope": "teams", - "id": "getLegacy", - "method": "GET", - "url": "/teams/{team_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Get a team by name](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-a-team-by-name) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#get-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "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\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get team member (Legacy)", - "scope": "teams", - "id": "getMemberLegacy", - "method": "GET", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-21", - "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-team-membership-for-a-user) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-team-member-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { "code": 204, "description": "if user is a member", "examples": null }, - { - "code": 404, - "description": "if user is not a member", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get team membership for a user", - "scope": "teams", - "id": "getMembershipForUserInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\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}/memberships/{username}`.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see see [Create a team](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#create-a-team).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-team-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": "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": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"maintainer\",\"state\":\"active\"}" - } - ] - }, - { - "code": 404, - "description": "if user has no team membership", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get team membership for a user (Legacy)", - "scope": "teams", - "id": "getMembershipForUserLegacy", - "method": "GET", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Get team membership for a user](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-team-membership-for-a-user) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:**\nThe response contains the `state` of the membership and the member's `role`.\n\nThe `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#create-a-team).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-team-membership-for-a-user-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"maintainer\",\"state\":\"active\"}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List teams", - "scope": "teams", - "id": "list", - "method": "GET", - "url": "/orgs/{org}/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all teams in an organization that are visible to the authenticated user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-teams", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List child teams", - "scope": "teams", - "id": "listChildInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/teams", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the child teams of the team specified by `{team_slug}`.\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}/teams`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-child-teams", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "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": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if child teams exist", - "examples": [ - { - "data": "[{\"id\":2,\"node_id\":\"MDQ6VGVhbTI=\",\"url\":\"https://api.github.com/teams/2\",\"name\":\"Original Roster\",\"slug\":\"original-roster\",\"description\":\"Started it all.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/2/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/2/repos\",\"parent\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"},\"html_url\":\"https://github.com/orgs/rails/teams/core\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List child teams (Legacy)", - "scope": "teams", - "id": "listChildLegacy", - "method": "GET", - "url": "/teams/{team_id}/teams", - "isDeprecated": true, - "deprecationDate": "2020-01-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 child teams`](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-child-teams) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#list-child-teams-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "if child teams exist", - "examples": [ - { - "data": "[{\"id\":2,\"node_id\":\"MDQ6VGVhbTI=\",\"url\":\"https://api.github.com/teams/2\",\"name\":\"Original Roster\",\"slug\":\"original-roster\",\"description\":\"Started it all.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/2/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/2/repos\",\"parent\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"},\"html_url\":\"https://github.com/orgs/rails/teams/core\"}]" - } - ] - }, - { "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": "List discussion comments", - "scope": "teams", - "id": "listDiscussionCommentsInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-discussion-comments", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List discussion comments (Legacy)", - "scope": "teams", - "id": "listDiscussionCommentsLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "isDeprecated": true, - "deprecationDate": "2020-01-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 discussion comments](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-discussion-comments) endpoint.\n\nList all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-discussion-comments-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List discussions", - "scope": "teams", - "id": "listDiscussionsInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions", - "isDeprecated": false, - "deprecationDate": null, - "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-discussions", - "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": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "pinned", - "description": "Pinned discussions only filter", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List discussions (Legacy)", - "scope": "teams", - "id": "listDiscussionsLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions", - "isDeprecated": true, - "deprecationDate": "2020-01-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 discussions`](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-discussions) endpoint.\n\nList all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-discussions-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction to sort the results by.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List teams for the authenticated user", - "scope": "teams", - "id": "listForAuthenticatedUser", - "method": "GET", - "url": "/user/teams", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/enterprise-server@3.3/apps/building-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-teams-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"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\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List team members", - "scope": "teams", - "id": "listMembersInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/members", - "isDeprecated": false, - "deprecationDate": null, - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-team-members", - "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", - "description": "Filters members returned by their role in the team.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["member", "maintainer", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List team members (Legacy)", - "scope": "teams", - "id": "listMembersLegacy", - "method": "GET", - "url": "/teams/{team_id}/members", - "isDeprecated": true, - "deprecationDate": "2020-01-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 team members`](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-team-members-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "Filters members returned by their role in the team.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["member", "maintainer", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List team projects", - "scope": "teams", - "id": "listProjectsInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/projects", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the organization projects for a team.\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}/projects`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-team-projects", - "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": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List team projects (Legacy)", - "scope": "teams", - "id": "listProjectsLegacy", - "method": "GET", - "url": "/teams/{team_id}/projects", - "isDeprecated": true, - "deprecationDate": "2020-01-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 team projects`](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-team-projects) endpoint.\n\nLists the organization projects for a team.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#list-team-projects-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List team repositories", - "scope": "teams", - "id": "listReposInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/repos", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists a team's repositories visible to the authenticated user.\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`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-team-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": "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": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List team repositories (Legacy)", - "scope": "teams", - "id": "listReposLegacy", - "method": "GET", - "url": "/teams/{team_id}/repos", - "isDeprecated": true, - "deprecationDate": "2020-01-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 team repositories](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-team-repositories) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#list-team-repositories-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Remove team member (Legacy)", - "scope": "teams", - "id": "removeMemberLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-21", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#remove-team-member-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 404, - "description": "Not Found if team synchronization is setup", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove team membership for a user", - "scope": "teams", - "id": "removeMembershipForUserInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#remove-team-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": "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": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 403, - "description": "Forbidden if team synchronization is set up", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove team membership for a user (Legacy)", - "scope": "teams", - "id": "removeMembershipForUserLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Remove team membership for a user](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#remove-team-membership-for-a-user-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "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 - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { - "code": 403, - "description": "if team synchronization is set up", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove a project from a team", - "scope": "teams", - "id": "removeProjectInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\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}/projects/{project_id}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#remove-a-project-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": "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": "project_id", - "description": "The unique identifier of the project.", - "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": "Remove a project from a team (Legacy)", - "scope": "teams", - "id": "removeProjectLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Remove a project from a team](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#remove-a-project-from-a-team) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#remove-a-project-from-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "project_id", - "description": "The unique identifier of the project.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Remove a repository from a team", - "scope": "teams", - "id": "removeRepoInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - "isDeprecated": false, - "deprecationDate": null, - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\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}/repos/{owner}/{repo}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#remove-a-repository-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": "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": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Remove a repository from a team (Legacy)", - "scope": "teams", - "id": "removeRepoLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Remove a repository from a team](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#remove-a-repository-from-a-team) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#remove-a-repository-from-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "The name of the repository. The name is not case sensitive.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], - "renamed": null - }, - { - "name": "Update a discussion comment", - "scope": "teams", - "id": "updateDiscussionCommentInOrg", - "method": "PATCH", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.3/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#update-a-discussion-comment", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like pineapples?\",\"body_html\":\"

Do you like pineapples?

\",\"body_version\":\"e6907b24d9c93cc0c5024a7af5888116\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a discussion comment (Legacy)", - "scope": "teams", - "id": "updateDiscussionCommentLegacy", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Update a discussion comment](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#update-a-discussion-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comment_number", - "description": "The number that identifies the comment.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"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},\"body\":\"Do you like pineapples?\",\"body_html\":\"

Do you like pineapples?

\",\"body_version\":\"e6907b24d9c93cc0c5024a7af5888116\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a discussion", - "scope": "teams", - "id": "updateDiscussionInOrg", - "method": "PATCH", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/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}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#update-a-discussion", - "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": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion post's body text.", - "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": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":1,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Welcome to our first team post\",\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a discussion (Legacy)", - "scope": "teams", - "id": "updateDiscussionLegacy", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Update a discussion](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#update-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "The number that identifies the discussion.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion post's body text.", - "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": "{\"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},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

Hi! This is an area for us to collaborate as a team

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":1,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Welcome to our first team post\",\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0,\"eyes\":1,\"rocket\":1}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update a team", - "scope": "teams", - "id": "updateInOrg", - "method": "PATCH", - "url": "/orgs/{org}/teams/{team_slug}", - "isDeprecated": false, - "deprecationDate": null, - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams#update-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": "name", - "description": "The name of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["secret", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response when the updated information already exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "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": "Update a team (Legacy)", - "scope": "teams", - "id": "updateLegacy", - "method": "PATCH", - "url": "/teams/{team_id}", - "isDeprecated": true, - "deprecationDate": "2020-01-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 [Update a team](https://docs.github.com/enterprise-server@3.3/rest/reference/teams#update-a-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#update-a-team-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.", - "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 team.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["secret", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response when the updated information already exists", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}" - } - ] - }, - { "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": "Add an email address for the authenticated user", - "scope": "users", - "id": "addEmailForAuthenticated", - "method": "POST", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint is accessible with the `user` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#add-an-email-address-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "emails", - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@octocat.org\",\"primary\":false,\"verified\":false,\"visibility\":\"public\"},{\"email\":\"octocat@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null},{\"email\":\"mona@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": { - "before": { "scope": "users", "id": "addEmailForAuthenticated" }, - "after": { "scope": "users", "id": "addEmailForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Add an email address for the authenticated user", - "scope": "users", - "id": "addEmailForAuthenticatedUser", - "method": "POST", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint is accessible with the `user` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#add-an-email-address-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "emails", - "description": "Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@octocat.org\",\"primary\":false,\"verified\":false,\"visibility\":\"public\"},{\"email\":\"octocat@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null},{\"email\":\"mona@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check if a user follows another user", - "scope": "users", - "id": "checkFollowingForUser", - "method": "GET", - "url": "/users/{username}/following/{target_user}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#check-if-a-user-follows-another-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_user", - "description": "", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "if the user follows the target user", - "examples": null - }, - { - "code": 404, - "description": "if the user does not follow the target user", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Check if a person is followed by the authenticated user", - "scope": "users", - "id": "checkPersonIsFollowedByAuthenticated", - "method": "GET", - "url": "/user/following/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#check-if-a-person-is-followed-by-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 204, - "description": "if the person is followed by the authenticated user", - "examples": null - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { - "code": 404, - "description": "if the person is not followed by the authenticated user", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a GPG key for the authenticated user", - "scope": "users", - "id": "createGpgKeyForAuthenticated", - "method": "POST", - "url": "/user/gpg_keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#create-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "armored_public_key", - "description": "A GPG key in ASCII-armored format.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": { - "before": { "scope": "users", "id": "createGpgKeyForAuthenticated" }, - "after": { "scope": "users", "id": "createGpgKeyForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Create a GPG key for the authenticated user", - "scope": "users", - "id": "createGpgKeyForAuthenticatedUser", - "method": "POST", - "url": "/user/gpg_keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#create-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "armored_public_key", - "description": "A GPG key in ASCII-armored format.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Create a public SSH key for the authenticated user", - "scope": "users", - "id": "createPublicSshKeyForAuthenticated", - "method": "POST", - "url": "/user/keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "title", - "description": "A descriptive name for the new key.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key", - "description": "The public SSH key to add to your GitHub account.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": { - "before": { - "scope": "users", - "id": "createPublicSshKeyForAuthenticated" - }, - "after": { - "scope": "users", - "id": "createPublicSshKeyForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Create a public SSH key for the authenticated user", - "scope": "users", - "id": "createPublicSshKeyForAuthenticatedUser", - "method": "POST", - "url": "/user/keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#create-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "title", - "description": "A descriptive name for the new key.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "key", - "description": "The public SSH key to add to your GitHub account.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ", - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Response", - "examples": [ - { - "data": "{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete an email address for the authenticated user", - "scope": "users", - "id": "deleteEmailForAuthenticated", - "method": "DELETE", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint is accessible with the `user` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#delete-an-email-address-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "emails", - "description": "Email addresses associated with the GitHub user account.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": { - "before": { "scope": "users", "id": "deleteEmailForAuthenticated" }, - "after": { "scope": "users", "id": "deleteEmailForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Delete an email address for the authenticated user", - "scope": "users", - "id": "deleteEmailForAuthenticatedUser", - "method": "DELETE", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": null, - "description": "This endpoint is accessible with the `user` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#delete-an-email-address-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "emails", - "description": "Email addresses associated with the GitHub user account.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a GPG key for the authenticated user", - "scope": "users", - "id": "deleteGpgKeyForAuthenticated", - "method": "DELETE", - "url": "/user/gpg_keys/{gpg_key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gpg_key_id", - "description": "The unique identifier of the GPG key.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": { - "before": { "scope": "users", "id": "deleteGpgKeyForAuthenticated" }, - "after": { "scope": "users", "id": "deleteGpgKeyForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Delete a GPG key for the authenticated user", - "scope": "users", - "id": "deleteGpgKeyForAuthenticatedUser", - "method": "DELETE", - "url": "/user/gpg_keys/{gpg_key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gpg_key_id", - "description": "The unique identifier of the GPG key.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Delete a public SSH key for the authenticated user", - "scope": "users", - "id": "deletePublicSshKeyForAuthenticated", - "method": "DELETE", - "url": "/user/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_id", - "description": "The unique identifier of the key.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { - "scope": "users", - "id": "deletePublicSshKeyForAuthenticated" - }, - "after": { - "scope": "users", - "id": "deletePublicSshKeyForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Delete a public SSH key for the authenticated user", - "scope": "users", - "id": "deletePublicSshKeyForAuthenticatedUser", - "method": "DELETE", - "url": "/user/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_id", - "description": "The unique identifier of the key.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Follow a user", - "scope": "users", - "id": "follow", - "method": "PUT", - "url": "/user/following/{username}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#follow-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get the authenticated user", - "scope": "users", - "id": "getAuthenticated", - "method": "GET", - "url": "/user", - "isDeprecated": false, - "deprecationDate": null, - "description": "If the authenticated user is authenticated through basic authentication or OAuth 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#get-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"private_gists\":81,\"total_private_repos\":100,\"owned_private_repos\":100,\"disk_usage\":10000,\"collaborators\":8,\"two_factor_authentication\":true,\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"collaborators\":0}}" - }, - { - "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,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a user", - "scope": "users", - "id": "getByUsername", - "method": "GET", - "url": "/users/{username}", - "isDeprecated": false, - "deprecationDate": 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 Enterprise Server plan. The GitHub App must be authenticated as a user. See \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/enterprise-server@3.3/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)\" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below\"\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [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 Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.3/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/enterprise-server@3.3/rest/reference/users#emails)\".", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#get-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"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\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"twitter_username\":\"monatheoctocat\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\"}" - }, - { - "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,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"twitter_username\":\"monatheoctocat\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"plan\":{\"name\":\"pro\",\"space\":976562499,\"collaborators\":0,\"private_repos\":9999}}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get contextual information for a user", - "scope": "users", - "id": "getContextForUser", - "method": "GET", - "url": "/users/{username}/hovercard", - "isDeprecated": false, - "deprecationDate": 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```", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#get-contextual-information-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "subject_type", - "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["organization", "repository", "issue", "pull_request"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "subject_id", - "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "{\"contexts\":[{\"message\":\"Owns this repository\",\"octicon\":\"repo\"}]}" - } - ] - }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - }, - { - "name": "Get a GPG key for the authenticated user", - "scope": "users", - "id": "getGpgKeyForAuthenticated", - "method": "GET", - "url": "/user/gpg_keys/{gpg_key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#get-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gpg_key_id", - "description": "The unique identifier of the GPG key.", - "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\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "getGpgKeyForAuthenticated" }, - "after": { "scope": "users", "id": "getGpgKeyForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Get a GPG key for the authenticated user", - "scope": "users", - "id": "getGpgKeyForAuthenticatedUser", - "method": "GET", - "url": "/user/gpg_keys/{gpg_key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#get-a-gpg-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "gpg_key_id", - "description": "The unique identifier of the GPG key.", - "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\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"\\\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\\\nVersion: GnuPG v2\\\\n\\\\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\\\\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\\\\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\\\\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\\\\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\\\\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\\\\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\\\\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\\\\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\\\\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\\\\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\\\\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\\\\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\\\\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\\\\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\\\\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\\\\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\\\\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\\\\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\\\\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\\\\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\\\\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\\\\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\\\\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\\\\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\\\\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\\\\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\\\\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\\\\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\\\\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\\\\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\\\\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\\\\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\\\\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\\\\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\\\\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\\\\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\\\\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\\\\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\\\\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\\\\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\\\\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\\\\nIts/HFYRLiFgDLmTlxo=\\\\n=+OzK\\\\n-----END PGP PUBLIC KEY BLOCK-----\\\"\"}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Get a public SSH key for the authenticated user", - "scope": "users", - "id": "getPublicSshKeyForAuthenticated", - "method": "GET", - "url": "/user/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_id", - "description": "The unique identifier of the key.", - "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": "{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "getPublicSshKeyForAuthenticated" }, - "after": { - "scope": "users", - "id": "getPublicSshKeyForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "Get a public SSH key for the authenticated user", - "scope": "users", - "id": "getPublicSshKeyForAuthenticatedUser", - "method": "GET", - "url": "/user/keys/{key_id}", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "key_id", - "description": "The unique identifier of the key.", - "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": "{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List users", - "scope": "users", - "id": "list", - "method": "GET", - "url": "/users", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of users.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-users", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "A user ID. Only return users with an ID greater than this ID.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null } - ], - "renamed": null - }, - { - "name": "List email addresses for the authenticated user", - "scope": "users", - "id": "listEmailsForAuthenticated", - "method": "GET", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-email-addresses-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "listEmailsForAuthenticated" }, - "after": { "scope": "users", "id": "listEmailsForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "List email addresses for the authenticated user", - "scope": "users", - "id": "listEmailsForAuthenticatedUser", - "method": "GET", - "url": "/user/emails", - "isDeprecated": false, - "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-email-addresses-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List the people the authenticated user follows", - "scope": "users", - "id": "listFollowedByAuthenticated", - "method": "GET", - "url": "/user/following", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people who the authenticated user follows.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-the-people-the-authenticated-user-follows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "listFollowedByAuthenticated" }, - "after": { "scope": "users", "id": "listFollowedByAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "List the people the authenticated user follows", - "scope": "users", - "id": "listFollowedByAuthenticatedUser", - "method": "GET", - "url": "/user/following", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people who the authenticated user follows.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-the-people-the-authenticated-user-follows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List followers of the authenticated user", - "scope": "users", - "id": "listFollowersForAuthenticatedUser", - "method": "GET", - "url": "/user/followers", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people following the authenticated user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-followers-of-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null } - ], - "renamed": null - }, - { - "name": "List followers of a user", - "scope": "users", - "id": "listFollowersForUser", - "method": "GET", - "url": "/users/{username}/followers", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people following the specified user.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-followers-of-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List the people a user follows", - "scope": "users", - "id": "listFollowingForUser", - "method": "GET", - "url": "/users/{username}/following", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the people who the specified user follows.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-the-people-a-user-follows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List GPG keys for the authenticated user", - "scope": "users", - "id": "listGpgKeysForAuthenticated", - "method": "GET", - "url": "/user/gpg_keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-gpg-keys-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"string\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "listGpgKeysForAuthenticated" }, - "after": { "scope": "users", "id": "listGpgKeysForAuthenticatedUser" }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "List GPG keys for the authenticated user", - "scope": "users", - "id": "listGpgKeysForAuthenticatedUser", - "method": "GET", - "url": "/user/gpg_keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-gpg-keys-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"string\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List GPG keys for a user", - "scope": "users", - "id": "listGpgKeysForUser", - "method": "GET", - "url": "/users/{username}/gpg_keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the GPG keys for a user. This information is accessible by anyone.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-gpg-keys-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"id\":3,\"primary_key_id\":2,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"octocat@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\"}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":\"2016-03-24T11:31:04-07:00\",\"raw_key\":\"string\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public email addresses for the authenticated user", - "scope": "users", - "id": "listPublicEmailsForAuthenticated", - "method": "GET", - "url": "/user/public_emails", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-public-email-addresses-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "listPublicEmailsForAuthenticated" }, - "after": { - "scope": "users", - "id": "listPublicEmailsForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "List public email addresses for the authenticated user", - "scope": "users", - "id": "listPublicEmailsForAuthenticatedUser", - "method": "GET", - "url": "/user/public_emails", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-public-email-addresses-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "List public keys for a user", - "scope": "users", - "id": "listPublicKeysForUser", - "method": "GET", - "url": "/users/{username}/keys", - "isDeprecated": false, - "deprecationDate": null, - "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-public-keys-for-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [{ "data": "[{\"id\":1,\"key\":\"ssh-rsa AAA...\"}]" }] - } - ], - "renamed": null - }, - { - "name": "List public SSH keys for the authenticated user", - "scope": "users", - "id": "listPublicSshKeysForAuthenticated", - "method": "GET", - "url": "/user/keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false},{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234\",\"id\":3,\"url\":\"https://api.github.com/user/keys/3\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAB\",\"created_at\":\"2020-07-11T21:31:57Z\",\"verified\":false,\"read_only\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": { - "before": { "scope": "users", "id": "listPublicSshKeysForAuthenticated" }, - "after": { - "scope": "users", - "id": "listPublicSshKeysForAuthenticatedUser" - }, - "date": "2021-10-05", - "note": null - } - }, - { - "name": "List public SSH keys for the authenticated user", - "scope": "users", - "id": "listPublicSshKeysForAuthenticatedUser", - "method": "GET", - "url": "/user/keys", - "isDeprecated": false, - "deprecationDate": 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/enterprise-server@3.3/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\",\"id\":2,\"url\":\"https://api.github.com/user/keys/2\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAA\",\"created_at\":\"2020-06-11T21:31:57Z\",\"verified\":false,\"read_only\":false},{\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234\",\"id\":3,\"url\":\"https://api.github.com/user/keys/3\",\"title\":\"ssh-rsa AAAAB3NzaC1yc2EAAB\",\"created_at\":\"2020-07-11T21:31:57Z\",\"verified\":false,\"read_only\":false}]" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Unfollow a user", - "scope": "users", - "id": "unfollow", - "method": "DELETE", - "url": "/user/following/{username}", - "isDeprecated": false, - "deprecationDate": null, - "description": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users#unfollow-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "username", - "description": "The handle for the GitHub user account.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { "code": 204, "description": "Response", "examples": null }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null } - ], - "renamed": null - }, - { - "name": "Update the authenticated user", - "scope": "users", - "id": "updateAuthenticated", - "method": "PATCH", - "url": "/user", - "isDeprecated": false, - "deprecationDate": null, - "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/users/#update-the-authenticated-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "name", - "description": "The new name of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "email", - "description": "The publicly visible email address of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "blog", - "description": "The new blog URL of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "twitter_username", - "description": "The new Twitter username of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "company", - "description": "The new company of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "location", - "description": "The new location of the user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hireable", - "description": "The new hiring availability of the user.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "bio", - "description": "The new short biography of the user.", - "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": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"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\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"private_gists\":81,\"total_private_repos\":100,\"owned_private_repos\":100,\"disk_usage\":10000,\"collaborators\":8,\"two_factor_authentication\":true,\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"collaborators\":0}}" - } - ] - }, - { "code": 304, "description": "Not modified", "examples": null }, - { - "code": 401, - "description": "Requires authentication", - "examples": null - }, - { "code": 403, "description": "Forbidden", "examples": null }, - { "code": 404, "description": "Resource not found", "examples": null }, - { - "code": 422, - "description": "Validation failed, or the endpoint has been spammed.", - "examples": null - } - ], - "renamed": null - } -] diff --git a/scripts/update-endpoints/generated/ghe34-endpoints.json b/scripts/update-endpoints/generated/ghe34-endpoints.json index 0a0e6792..6dc409a0 100644 --- a/scripts/update-endpoints/generated/ghe34-endpoints.json +++ b/scripts/update-endpoints/generated/ghe34-endpoints.json @@ -294,7 +294,7 @@ "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/actions#create-or-update-an-environment-secret", "previews": [], "headers": [], @@ -493,7 +493,7 @@ "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/actions#create-or-update-a-repository-secret", "previews": [], "headers": [], @@ -772,7 +772,7 @@ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", "isDeprecated": false, "deprecationDate": 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\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/enterprise-server@3.4/articles/creating-a-personal-access-token-for-the-command-line).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/actions#create-a-workflow-dispatch-event", "previews": [], "headers": [], @@ -2778,6 +2778,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "name", + "description": "Filters artifacts by exact match on their name field.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -3877,7 +3890,7 @@ }, { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.4/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "QUERY", "type": "string", "required": false, @@ -4048,7 +4061,7 @@ }, { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.4/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "QUERY", "type": "string", "required": false, @@ -5112,7 +5125,7 @@ }, { "name": "selected_repository_ids", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.4/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", "in": "BODY", "type": "integer[]", "required": true, @@ -5289,7 +5302,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -5406,14 +5419,14 @@ "url": "/notifications/threads/{thread_id}", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Gets information about a notification thread.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/activity#get-a-thread", "previews": [], "headers": [], "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -5460,7 +5473,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -6244,7 +6257,7 @@ "url": "/repos/{owner}/{repo}/notifications", "isDeprecated": false, "deprecationDate": null, - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-repository-notifications-for-the-authenticated-user", "previews": [], "headers": [], @@ -6613,7 +6626,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] } @@ -6753,7 +6766,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] }, @@ -6854,7 +6867,7 @@ "url": "/notifications", "isDeprecated": false, "deprecationDate": null, - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/activity#mark-notifications-as-read", "previews": [], "headers": [], @@ -6915,7 +6928,7 @@ "url": "/repos/{owner}/{repo}/notifications", "isDeprecated": false, "deprecationDate": null, - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/activity#mark-repository-notifications-as-read", "previews": [], "headers": [], @@ -6961,7 +6974,15 @@ } ], "responses": [ - { "code": 202, "description": "Response", "examples": null }, + { + "code": 202, + "description": "Response", + "examples": [ + { + "data": "{\"message\":\"Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background.\"}" + } + ] + }, { "code": 205, "description": "Reset Content", "examples": null } ], "renamed": null @@ -6974,14 +6995,14 @@ "url": "/notifications/threads/{thread_id}", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/activity#mark-a-thread-as-read", "previews": [], "headers": [], "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -7094,7 +7115,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.4/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -8102,7 +8123,7 @@ "url": "/apps/{app_slug}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.4/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/enterprise-server@3.4/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/enterprise-server@3.4/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/apps/#get-an-app", "previews": [], "headers": [], @@ -8691,6 +8712,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "redelivery", + "description": "", + "in": "QUERY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -8741,7 +8775,11 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 400, "description": "Bad Request", "examples": null }, { "code": 400, "description": "Bad Request", "examples": null }, { @@ -10565,7 +10603,11 @@ } ], "responses": [ - { "code": 201, "description": "Response", "examples": null }, + { + "code": 201, + "description": "Response", + "examples": [{ "data": "null" }] + }, { "code": 403, "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App", @@ -10633,7 +10675,13 @@ "deprecated": null } ], - "responses": [{ "code": 201, "description": "Response", "examples": null }], + "responses": [ + { + "code": 201, + "description": "Response", + "examples": [{ "data": "null" }] + } + ], "renamed": null }, { @@ -10677,7 +10725,7 @@ }, { "name": "auto_trigger_checks", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "in": "BODY", "type": "object[]", "required": false, @@ -10882,7 +10930,7 @@ }, { "name": "output", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "in": "BODY", "type": "object", "required": false, @@ -10934,7 +10982,7 @@ }, { "name": "output.annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-server@3.4/articles/about-status-checks#checks)\".", "in": "BODY", "type": "object[]", "required": false, @@ -10960,7 +11008,7 @@ }, { "name": "output.annotations[].start_line", - "description": "The start line of the annotation.", + "description": "The start line of the annotation. Line numbers start at 1.", "in": "BODY", "type": "integer", "required": true, @@ -10986,7 +11034,7 @@ }, { "name": "output.annotations[].start_column", - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1.", "in": "BODY", "type": "integer", "required": false, @@ -11064,7 +11112,7 @@ }, { "name": "output.images", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.4/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "in": "BODY", "type": "object[]", "required": false, @@ -12140,7 +12188,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/sarifs", "isDeprecated": false, "deprecationDate": 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.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n- If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n- If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n
\nSARIF upload supports a maximum 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).\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 15 | |\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| 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\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/reference/code-scanning#get-information-about-a-sarif-upload).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/code-scanning#upload-a-sarif-file", "previews": [], "headers": [], @@ -12530,7 +12578,7 @@ "url": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository\npermission to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository\npermission to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#create-or-update-a-repository-secret", "previews": [], "headers": [], @@ -13433,7 +13481,7 @@ "url": "{origin}/setup/api/start", "isDeprecated": false, "deprecationDate": null, - "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", + "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#create-a-github-enterprise-server-license", "previews": [], "headers": [], @@ -13656,7 +13704,7 @@ "description": "A list of [scopes](https://docs.github.com/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "in": "BODY", "type": "string[]", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -14495,7 +14543,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Gets the current message and expiration date of the global announcement banner in your enterprise.", - "documentationUrl": "", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/enterprise-admin/announcement#get-the-global-announcement-banner", "previews": [], "headers": [], "parameters": [], @@ -14505,7 +14553,7 @@ "description": "Response", "examples": [ { - "data": "{\"announcement\":\"Very **important** announcement about _nothing_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\"}" + "data": "{\"announcement\":\"Very **important** announcement about _something_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\",\"user_dismissible\":false}" } ] } @@ -14525,7 +14573,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_commit_comments\":5000,\"total_gist_comments\":400,\"total_issue_comments\":10900,\"total_pull_request_comments\":9900}" + } + ] + } + ], "renamed": null }, { @@ -14621,7 +14679,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_gists\":500,\"private_gists\":30,\"public_gists\":470}" + } + ] + } + ], "renamed": null }, { @@ -14717,7 +14785,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_hooks\":50,\"active_hooks\":47,\"inactive_hooks\":3}" + } + ] + } + ], "renamed": null }, { @@ -14733,7 +14811,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_issues\":5000,\"open_issues\":300,\"closed_issues\":4700}" + } + ] + } + ], "renamed": null }, { @@ -14815,7 +14903,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_milestones\":90,\"open_milestones\":10,\"closed_milestones\":80}" + } + ] + } + ], "renamed": null }, { @@ -14831,7 +14929,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_orgs\":50,\"disabled_orgs\":1,\"total_teams\":70,\"total_team_members\":700}" + } + ] + } + ], "renamed": null }, { @@ -14847,7 +14955,13 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [{ "data": "{\"total_pages\":20}" }] + } + ], "renamed": null }, { @@ -15062,7 +15176,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_pulls\":1200,\"merged_pulls\":1100,\"mergeable_pulls\":90,\"unmergeable_pulls\":10}" + } + ] + } + ], "renamed": null }, { @@ -15078,7 +15202,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_repos\":200,\"root_repos\":1,\"fork_repos\":10,\"org_repos\":150,\"total_pushes\":39000,\"total_wikis\":5}" + } + ] + } + ], "renamed": null }, { @@ -15134,7 +15268,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_users\":100,\"admin_users\":3,\"suspended_users\":1}" + } + ] + } + ], "renamed": null }, { @@ -15938,7 +16082,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Removes the global announcement banner in your enterprise.", - "documentationUrl": "", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/enterprise-admin/announcement#remove-the-global-announcement-banner", "previews": [], "headers": [], "parameters": [], @@ -16254,7 +16398,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Sets the message and expiration time for the global announcement banner in your enterprise.", - "documentationUrl": "", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/enterprise-admin/announcement#set-the-global-announcement-banner", "previews": [], "headers": [], "parameters": [ @@ -16265,7 +16409,7 @@ "type": "string", "required": true, "enum": null, - "allowNull": false, + "allowNull": true, "mapToData": null, "validation": null, "alias": null, @@ -16291,7 +16435,7 @@ "description": "Response", "examples": [ { - "data": "{\"announcement\":\"Very **important** announcement about _nothing_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\"}" + "data": "{\"announcement\":\"Very **important** announcement about _something_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\",\"user_dismissible\":false}" } ] } @@ -17477,7 +17621,7 @@ "url": "{origin}/setup/api/upgrade", "isDeprecated": false, "deprecationDate": null, - "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", + "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#upgrade-a-license", "previews": [], "headers": [], @@ -17640,7 +17784,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" } ] }, @@ -17875,7 +18019,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" } ] }, @@ -17987,7 +18131,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" } ] }, @@ -18584,7 +18728,7 @@ "url": "/gists/{gist_id}", "isDeprecated": false, "deprecationDate": null, - "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", + "description": "Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/gists/#update-a-gist", "previews": [], "headers": [], @@ -18604,7 +18748,7 @@ }, { "name": "description", - "description": "Description of the gist", + "description": "The description of the gist.", "in": "BODY", "type": "string", "required": false, @@ -18617,7 +18761,7 @@ }, { "name": "files", - "description": "Names of files to be updated", + "description": "The gist files to be updated, renamed, or deleted. Each `key` must match the current filename\n(including extension) of the targeted gist file. For example: `hello.py`.\n\nTo delete a file, set the whole file to null. For example: `hello.py : null`.", "in": "BODY", "type": "object", "required": false, @@ -18643,7 +18787,7 @@ }, { "name": "files.*.content", - "description": "The new content of the file", + "description": "The new content of the file.", "in": "BODY", "type": "string", "required": false, @@ -18656,7 +18800,7 @@ }, { "name": "files.*.filename", - "description": "The new filename for the file", + "description": "The new filename for the file.", "in": "BODY", "type": "string", "required": false, @@ -18674,7 +18818,13 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" + }, + { + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":null,\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"A gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"9cc352a89178a6d4\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":1,\"additions\":0,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" + }, + { + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"goodbye.py\":{\"filename\":\"goodbye.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/8481a81af6b7a2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/goodbye.py\",\"size\":4,\"truncated\":false,\"content\":\"# Hello world\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"A gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":0,\"additions\":0,\"deletions\":0},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" } ] }, @@ -20368,6 +20518,86 @@ ], "renamed": null }, + { + "name": "Check if a user can be assigned to a issue", + "scope": "issues", + "id": "checkUserCanBeAssignedToIssue", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/issues#check-if-a-user-can-be-assigned-to-a-issue", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "assignee", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 204, + "description": "Response if `assignee` can be assigned to `issue_number`", + "examples": null + }, + { + "code": 404, + "description": "Response if `assignee` can not be assigned to `issue_number`", + "examples": null + } + ], + "renamed": null + }, { "name": "Create an issue", "scope": "issues", @@ -20376,7 +20606,7 @@ "url": "/repos/{owner}/{repo}/issues", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/issues#create-an-issue", "previews": [], "headers": [], @@ -20983,7 +21213,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}", "isDeprecated": false, "deprecationDate": null, - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/issues#get-an-issue", "previews": [], "headers": [], @@ -21323,7 +21553,7 @@ "url": "/issues", "isDeprecated": false, "deprecationDate": 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 v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/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\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/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/issues#list-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], @@ -21520,7 +21750,7 @@ "url": "/repos/{owner}/{repo}/assignees", "isDeprecated": false, "deprecationDate": null, - "description": "Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "description": "Lists the [available assignees](https://docs.github.com/enterprise-server@3.4/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/issues#list-assignees", "previews": [], "headers": [], @@ -22102,7 +22332,7 @@ "url": "/user/issues", "isDeprecated": false, "deprecationDate": null, - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/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/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], @@ -22242,7 +22472,7 @@ "url": "/orgs/{org}/issues", "isDeprecated": false, "deprecationDate": null, - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/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/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], @@ -22394,7 +22624,7 @@ "url": "/repos/{owner}/{repo}/issues", "isDeprecated": false, "deprecationDate": null, - "description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/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/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/issues#list-repository-issues", "previews": [], "headers": [], @@ -23029,7 +23259,7 @@ }, { "name": "lock_reason", - "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", + "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`", "in": "BODY", "type": "string", "required": false, @@ -23445,7 +23675,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Issue owners and users with push access can edit an issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/issues/#update-an-issue", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/issues#update-an-issue", "previews": [], "headers": [], "parameters": [ @@ -24140,7 +24370,11 @@ } ], "responses": [ - { "code": 200, "description": "Response", "examples": null }, + { + "code": 200, + "description": "Response", + "examples": [{ "data": "\"

Hello world

\"" }] + }, { "code": 304, "description": "Not modified", "examples": null } ], "renamed": null @@ -24175,7 +24409,11 @@ } ], "responses": [ - { "code": 200, "description": "Response", "examples": null }, + { + "code": 200, + "description": "Response", + "examples": [{ "data": "\"

Hello world

\"" }] + }, { "code": 304, "description": "Not modified", "examples": null } ], "renamed": null @@ -24256,7 +24494,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Get a random sentence from the Zen of GitHub", - "documentationUrl": "", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/meta#get-the-zen-of-github", "previews": [], "headers": [], "parameters": [], @@ -24599,7 +24837,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] }, @@ -24666,7 +24904,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] }, @@ -25119,7 +25357,7 @@ "url": "/orgs/{org}/outside_collaborators/{username}", "isDeprecated": false, "deprecationDate": null, - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.4/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.4/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.4/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator", "previews": [], "headers": [], @@ -25173,7 +25411,7 @@ { "code": 204, "description": "User was converted", "examples": null }, { "code": 403, - "description": "Forbidden if user is the last owner of the organization or not a member of the organization.", + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.4/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null } @@ -25312,7 +25550,7 @@ }, { "name": "events", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", "in": "BODY", "type": "string[]", "required": false, @@ -25410,7 +25648,7 @@ "url": "/orgs/{org}", "isDeprecated": false, "deprecationDate": 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 Enterprise Server plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@3.4/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"", + "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.4/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 Enterprise Server plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@3.4/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/orgs#get-an-organization", "previews": [], "headers": [], @@ -25848,7 +26086,7 @@ "url": "/organizations/{organization_id}/custom_roles", "isDeprecated": false, "deprecationDate": null, - "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", + "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organization and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/orgs#list-custom-repository-roles-in-an-organization", "previews": [], "headers": [], @@ -25948,7 +26186,7 @@ "url": "/users/{username}/orgs", "isDeprecated": false, "deprecationDate": null, - "description": "List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", + "description": "List [public organization memberships](https://docs.github.com/enterprise-server@3.4/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.4/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/orgs#list-organizations-for-a-user", "previews": [], "headers": [], @@ -26390,6 +26628,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "redelivery", + "description": "", + "in": "QUERY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -26579,7 +26830,11 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 400, "description": "Bad Request", "examples": null }, { "code": 400, "description": "Bad Request", "examples": null }, { @@ -26821,7 +27076,7 @@ }, { "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.", + "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, @@ -26907,7 +27162,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/orgs/#update-an-organization", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/orgs#update-an-organization", "previews": [], "headers": [], "parameters": [ @@ -27069,7 +27324,7 @@ }, { "name": "members_can_create_internal_repositories", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.4/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -27082,7 +27337,7 @@ }, { "name": "members_can_create_private_repositories", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.4/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -27095,7 +27350,7 @@ }, { "name": "members_can_create_public_repositories", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.4/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -28614,7 +28869,7 @@ "description": "Response", "examples": [ { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}]" + "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":true}]" } ] }, @@ -29346,7 +29601,7 @@ "url": "/repos/{owner}/{repo}/pulls", "isDeprecated": false, "deprecationDate": 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/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/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#create-a-pull-request", "previews": [], "headers": [], @@ -29431,7 +29686,7 @@ }, { "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.4/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", "in": "BODY", "type": "boolean", "required": false, @@ -29444,7 +29699,7 @@ }, { "name": "draft", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-server@3.4/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", "in": "BODY", "type": "boolean", "required": false, @@ -29475,7 +29730,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" } ] }, @@ -29496,7 +29751,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", "isDeprecated": false, "deprecationDate": 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#create-a-reply-for-a-review-comment", "previews": [], "headers": [], @@ -29589,7 +29844,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "isDeprecated": false, "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/pulls#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 v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/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": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/pulls#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/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/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.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#create-a-review-for-a-pull-request", "previews": [], "headers": [], @@ -29804,7 +30059,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.4/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.4/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#create-a-review-comment-for-a-pull-request", "previews": [], "headers": [], @@ -29902,7 +30157,7 @@ }, { "name": "side", - "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-server@3.4/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "in": "BODY", "type": "string", "required": false, @@ -29928,7 +30183,7 @@ }, { "name": "start_line", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.4/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", "in": "BODY", "type": "integer", "required": false, @@ -29941,7 +30196,7 @@ }, { "name": "start_side", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.4/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "in": "BODY", "type": "string", "required": false, @@ -30248,7 +30503,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.4/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server 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/enterprise-server@3.4/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 Enterprise Server 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/enterprise-server@3.4/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/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server 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/enterprise-server@3.4/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 Enterprise Server 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/enterprise-server@3.4/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/enterprise-server@3.4/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/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#get-a-pull-request", "previews": [], "headers": [], @@ -30299,7 +30554,7 @@ "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.4/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" } ] }, @@ -30465,7 +30720,7 @@ "url": "/repos/{owner}/{repo}/pulls", "isDeprecated": false, "deprecationDate": 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": "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests", "previews": [], "headers": [], @@ -31404,7 +31659,7 @@ }, { "name": "merge_method", - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", + "description": "The merge method to use.", "in": "BODY", "type": "string", "required": false, @@ -31767,7 +32022,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/pulls/#update-a-pull-request", "previews": [], "headers": [], @@ -31865,7 +32120,7 @@ }, { "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.4/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", "in": "BODY", "type": "boolean", "required": false, @@ -31883,7 +32138,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" } ] }, @@ -34703,8 +34958,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#add-app-access-restrictions", + "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/enterprise-server@3.4/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.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#add-app-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -34736,7 +34991,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -34877,8 +35132,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#add-status-check-contexts", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#add-status-check-contexts", "previews": [], "headers": [], "parameters": [ @@ -34910,7 +35165,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -34963,8 +35218,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": 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 teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#add-team-access-restrictions", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#add-team-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -34996,7 +35251,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -35047,8 +35302,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": 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 people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#add-user-access-restrictions", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#add-user-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -35080,7 +35335,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -35305,7 +35560,7 @@ "url": "/repos/{owner}/{repo}/compare/{basehead}", "isDeprecated": false, "deprecationDate": null, - "description": "The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.4/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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\n**Working with large comparisons**\n\nTo process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"[Traversing with pagination](/rest/guides/traversing-with-pagination).\"\n\nWhen calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "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/enterprise-server@3.4/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/enterprise-server@3.4/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/enterprise-server@3.4/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 her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/commits/commits#compare-two-commits", "previews": [], "headers": [], @@ -35364,7 +35619,7 @@ }, { "name": "basehead", - "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.", + "description": "The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`.", "in": "PATH", "type": "string", "required": true, @@ -35497,7 +35752,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", "isDeprecated": false, "deprecationDate": null, - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/commits/comments#create-a-commit-comment", "previews": [], "headers": [], @@ -35621,8 +35876,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#create-commit-signature-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#create-commit-signature-protection", "previews": [], "headers": [], "parameters": [ @@ -35654,7 +35909,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -35807,7 +36062,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "You can create a read-only deploy key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#create-a-deploy-key", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deploy-keys#create-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -35865,7 +36120,7 @@ }, { "name": "read_only", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.4/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.4/articles/permission-levels-for-a-user-account-repository/).\"", "in": "BODY", "type": "boolean", "required": false, @@ -35904,7 +36159,7 @@ "isDeprecated": false, "deprecationDate": 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 Enterprise Server 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/enterprise-server@3.4/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#create-a-deployment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deployments/deployments#create-a-deployment", "previews": [], "headers": [], "parameters": [ @@ -36185,7 +36440,7 @@ "isDeprecated": false, "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#create-a-deployment-status", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deployments/statuses#create-a-deployment-status", "previews": [], "headers": [], "parameters": [ @@ -36354,7 +36609,7 @@ "url": "/repos/{owner}/{repo}/dispatches", "isDeprecated": false, "deprecationDate": null, - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server 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/enterprise-server@3.4/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 Enterprise Server 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/enterprise-server@3.4/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/enterprise-server@3.4/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#create-a-repository-dispatch-event", "previews": [], "headers": [], @@ -36400,7 +36655,7 @@ }, { "name": "client_payload", - "description": "JSON payload with extra information about the webhook event that your action or workflow may use.", + "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.", "in": "BODY", "type": "object", "required": false, @@ -36539,6 +36794,19 @@ "alias": null, "deprecated": null }, + { + "name": "has_discussions", + "description": "Whether discussions are enabled.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "team_id", "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", @@ -36918,7 +37186,7 @@ }, { "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", + "description": "The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/enterprise-server@3.4/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "in": "BODY", "type": "string", "required": false, @@ -36968,6 +37236,19 @@ "alias": null, "deprecated": null }, + { + "name": "has_downloads", + "description": "Whether downloads are enabled.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "is_template", "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", @@ -37022,7 +37303,7 @@ }, { "name": "license_template", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.4/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", "in": "BODY", "type": "string", "required": false, @@ -37192,7 +37473,7 @@ "isDeprecated": false, "deprecationDate": 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 \"[Secrets](/rest/reference/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#create-or-update-an-environment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deployments/environments#create-or-update-an-environment", "previews": [], "headers": [], "parameters": [ @@ -37591,7 +37872,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, - "description": "Configures a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"", + "description": "Configures a GitHub Enterprise Server 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 `administrative:write` and `pages:write` permissions.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/pages#create-a-github-pages-site", "previews": [], "headers": [], @@ -37702,7 +37983,7 @@ "url": "/repos/{owner}/{repo}/releases", "isDeprecated": false, "deprecationDate": null, - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#create-a-release", "previews": [], "headers": [], @@ -38295,8 +38576,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "isDeprecated": false, "deprecationDate": 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\nDisables the ability to restrict who can push to this branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-access-restrictions", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#delete-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -38328,7 +38609,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -38351,8 +38632,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "deprecationDate": 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\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-admin-branch-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#delete-admin-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -38384,7 +38665,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -38411,7 +38692,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "You must authenticate using an access token with the repo scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-an-environment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deployments/environments#delete-an-environment", "previews": [], "headers": [], "parameters": [ @@ -38527,8 +38808,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-branch-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#delete-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -38560,7 +38841,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -38645,8 +38926,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-commit-signature-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#delete-commit-signature-protection", "previews": [], "headers": [], "parameters": [ @@ -38678,7 +38959,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -38705,7 +38986,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-a-deploy-key", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deploy-keys#delete-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -38760,8 +39041,8 @@ "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.4/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#create-a-deployment-status).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-a-deployment", + "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/enterprise-server@3.4/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.4/rest/deployments/deployment-statuses#create-a-deployment-status).\"", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deployments/deployments#delete-a-deployment", "previews": [], "headers": [], "parameters": [ @@ -39140,7 +39421,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Deletes a a GitHub Enterprise Server 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 `administrative:write` and `pages:write` permissions.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/pages#delete-a-github-pages-site", "previews": [], "headers": [], @@ -39192,8 +39473,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#delete-pull-request-review-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#delete-pull-request-review-protection", "previews": [], "headers": [], "parameters": [ @@ -39225,7 +39506,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -39422,7 +39703,7 @@ "url": "/repos/{owner}/{repo}/lfs", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#disable-git-lfs-for-a-repository", "previews": [], "headers": [], @@ -39465,7 +39746,7 @@ "url": "/repos/{owner}/{repo}/tarball/{ref}", "isDeprecated": false, "deprecationDate": null, - "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", + "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#download-a-repository-archive", "previews": [], "headers": [], @@ -39521,7 +39802,7 @@ "url": "/repos/{owner}/{repo}/zipball/{ref}", "isDeprecated": false, "deprecationDate": null, - "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", + "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#download-a-repository-archive", "previews": [], "headers": [], @@ -39577,7 +39858,7 @@ "url": "/repos/{owner}/{repo}/lfs", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#enable-git-lfs-for-a-repository", "previews": [], "headers": [], @@ -39610,7 +39891,11 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 403, "description": "We will return a 403 with one of the following messages:\n\n- Git LFS support not enabled because Git LFS is globally disabled.\n- Git LFS support not enabled because Git LFS is disabled for the root repository in the network.\n- Git LFS support not enabled because Git LFS is disabled for .", @@ -39733,7 +40018,7 @@ "url": "/repos/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-a-repository", "previews": [], "headers": [], @@ -39771,7 +40056,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\":{\"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}}" + "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\"}}}}" } ] }, @@ -39789,8 +40074,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "isDeprecated": false, "deprecationDate": 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 who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-access-restrictions", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -39822,7 +40107,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -39856,8 +40141,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-admin-branch-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-admin-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -39889,7 +40174,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -40001,8 +40286,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-all-status-check-contexts", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-all-status-check-contexts", "previews": [], "headers": [], "parameters": [ @@ -40034,7 +40319,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -40142,8 +40427,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-apps-with-access-to-the-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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -40175,7 +40460,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -40277,7 +40562,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-a-branch", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branches#get-a-branch", "previews": [], "headers": [], "parameters": [ @@ -40309,7 +40594,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -40344,8 +40629,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-branch-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -40377,7 +40662,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -40449,7 +40734,11 @@ "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", "examples": [{ "data": "[[1302998400,1124,-435]]" }] }, - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 204, "description": "A header with no content is returned.", @@ -40768,7 +41057,11 @@ } ] }, - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 204, "description": "A header with no content is returned.", @@ -40852,8 +41145,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-commit-signature-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.4/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-commit-signature-protection", "previews": [], "headers": [], "parameters": [ @@ -40885,7 +41178,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -40978,13 +41271,24 @@ } ], "responses": [ - { "code": 200, "description": "Response", "examples": null }, { "code": 200, "description": "Response", "examples": [ { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" + "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\\\nIHdvcmtmbG93Lgo=\\\\n\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" + }, + { + "data": "{\"type\":\"dir\",\"size\":0,\"name\":\"src\",\"path\":\"src\",\"sha\":\"2962be1c94eaae9794b3080790ec9d74b2fa8358\",\"url\":\"https://api.github.com/repos/octocat/octorepo/contents/src?ref=main\",\"git_url\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octocat/octorepo/blob/main/src\",\"download_url\":\"https://raw.githubusercontent.com/octocat/octorepo/main/src\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/octorepo/contents/src\",\"git\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octocat/octorepo/blob/main/src\"},\"entries\":[{\"type\":\"file\",\"size\":625,\"name\":\"app.js\",\"path\":\"src/app.js\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octocat/octorepo/contents/src/app.js\",\"git_url\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octocat/octorepo/blob/main/src/app.js\",\"download_url\":\"https://raw.githubusercontent.com/octocat/octorepo/main/src/app.js\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/octorepo/contents/src/app.js\",\"git\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octocat/octorepo/blob/main/src/app.js\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"images\",\"path\":\"src/images\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octocat/octorepo/contents/src/images\",\"git_url\":\"https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octocat/octorepo/tree/main/src/images\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octocat/octorepo/contents/src/images\",\"git\":\"https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octocat/octorepo/tree/main/src/images\"}}]}" + } + ] + }, + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\\\nIHdvcmtmbG93Lgo=\\\\n\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" }, { "data": "[{\"type\":\"file\",\"size\":625,\"name\":\"octokit.rb\",\"path\":\"lib/octokit.rb\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb\",\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"octokit\",\"path\":\"lib/octokit\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\"}}]" @@ -41053,7 +41357,11 @@ } ] }, - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 204, "description": "A header with no content is returned.", @@ -41071,7 +41379,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-a-deploy-key", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deploy-keys#get-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -41138,7 +41446,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-a-deployment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deployments/deployments#get-a-deployment", "previews": [], "headers": [], "parameters": [ @@ -41284,7 +41592,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Users with pull access can view a deployment status for a deployment:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-a-deployment-status", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deployments/statuses#get-a-deployment-status", "previews": [], "headers": [], "parameters": [ @@ -41364,7 +41672,7 @@ "isDeprecated": false, "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-an-environment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deployments/environments#get-an-environment", "previews": [], "headers": [], "parameters": [ @@ -41709,8 +42017,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-pull-request-review-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-pull-request-review-protection", "previews": [], "headers": [], "parameters": [ @@ -41742,7 +42050,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -42188,8 +42496,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#get-status-checks-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#get-status-checks-protection", "previews": [], "headers": [], "parameters": [ @@ -42221,7 +42529,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -42255,8 +42563,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": 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 teams who have push access to this branch. The list includes child teams.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-teams-with-access-to-the-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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -42288,7 +42596,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -42322,8 +42630,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": 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 people who have push access to this branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-users-with-access-to-the-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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -42355,7 +42663,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -42675,7 +42983,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-branches", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branches#list-branches", "previews": [], "headers": [], "parameters": [ @@ -42767,7 +43075,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "isDeprecated": false, "deprecationDate": 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\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/commits/commits#list-branches-for-head-commit", "previews": [], "headers": [], @@ -42963,19 +43271,6 @@ "alias": null, "deprecated": null }, - { - "name": "permission", - "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["pull", "triage", "push", "maintain", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "per_page", "description": "The number of results per page (max 100).", @@ -43322,7 +43617,7 @@ }, { "name": "sha", - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).", "in": "QUERY", "type": "string", "required": false, @@ -43438,7 +43733,7 @@ "url": "/repos/{owner}/{repo}/contributors", "isDeprecated": false, "deprecationDate": null, - "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", + "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-repository-contributors", "previews": [], "headers": [], @@ -43538,7 +43833,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-deploy-keys", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deploy-keys#list-deploy-keys", "previews": [], "headers": [], "parameters": [ @@ -43701,7 +43996,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Users with pull access can view deployment statuses for a deployment:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-deployment-statuses", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deployments/statuses#list-deployment-statuses", "previews": [], "headers": [], "parameters": [ @@ -43794,7 +44089,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Simple filtering of deployments is available via query parameters:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#list-deployments", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/deployments/deployments#list-deployments", "previews": [], "headers": [], "parameters": [ @@ -43944,7 +44239,7 @@ }, { "name": "affiliation", - "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", + "description": "Comma-separated list of values. Can include: \n * `owner`: Repositories that are owned by the authenticated user. \n * `collaborator`: Repositories that the user has been added to as a collaborator. \n * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", "in": "QUERY", "type": "string", "required": false, @@ -44100,7 +44395,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token.", + "description": "Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation access token.", "in": "QUERY", "type": "string", "required": false, @@ -44178,7 +44473,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] } @@ -44283,7 +44578,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] } @@ -44719,7 +45014,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "isDeprecated": false, "deprecationDate": null, - "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.", + "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/commits/commits#list-pull-requests-associated-with-a-commit", "previews": [], "headers": [], @@ -45210,6 +45505,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "redelivery", + "description": "", + "in": "QUERY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -45321,7 +45629,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#merge-a-branch", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branches#merge-a-branch", "previews": [], "headers": [], "parameters": [ @@ -45434,7 +45742,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository", "previews": [], "headers": [], "parameters": [ @@ -45627,7 +45935,11 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 400, "description": "Bad Request", "examples": null }, { "code": 400, "description": "Bad Request", "examples": null }, { @@ -45646,8 +45958,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#remove-app-access-restrictions", + "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/enterprise-server@3.4/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.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#remove-app-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -45679,7 +45991,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -45786,8 +46098,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#remove-status-check-contexts", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#remove-status-check-contexts", "previews": [], "headers": [], "parameters": [ @@ -45819,7 +46131,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -45867,8 +46179,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#remove-status-check-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#remove-status-check-protection", "previews": [], "headers": [], "parameters": [ @@ -45900,7 +46212,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -45923,8 +46235,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": 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 a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#remove-team-access-restrictions", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#remove-team-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -45956,7 +46268,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -46007,8 +46319,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": 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 a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#remove-user-access-restrictions", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#remove-user-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -46040,7 +46352,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -46092,7 +46404,7 @@ "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.4/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#rename-a-branch", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branches#rename-a-branch", "previews": [], "headers": [], "parameters": [ @@ -46124,7 +46436,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -46300,8 +46612,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "deprecationDate": 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\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#set-admin-branch-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#set-admin-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -46333,7 +46645,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -46366,8 +46678,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#set-app-access-restrictions", + "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/enterprise-server@3.4/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.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#set-app-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -46399,7 +46711,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -46450,8 +46762,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#set-status-check-contexts", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#set-status-check-contexts", "previews": [], "headers": [], "parameters": [ @@ -46483,7 +46795,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -46531,8 +46843,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": 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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#set-team-access-restrictions", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#set-team-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -46564,7 +46876,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -46615,8 +46927,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": 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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#set-user-access-restrictions", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#set-user-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -46648,7 +46960,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -46758,7 +47070,7 @@ "url": "/repos/{owner}/{repo}/transfer", "isDeprecated": false, "deprecationDate": 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/).", + "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/enterprise-server@3.4/articles/about-repository-transfers/).", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#transfer-a-repository", "previews": [], "headers": [], @@ -46838,7 +47150,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.4/rest/reference/repos#replace-all-repository-topics) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos/#update-a-repository", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/repos/repos#update-a-repository", "previews": [], "headers": [], "parameters": [ @@ -46909,7 +47221,7 @@ }, { "name": "private", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.4/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "in": "BODY", "type": "boolean", "required": false, @@ -46922,7 +47234,7 @@ }, { "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"", + "description": "The visibility of the repository.", "in": "BODY", "type": "string", "required": false, @@ -46933,97 +47245,6 @@ "alias": null, "deprecated": null }, - { - "name": "security_and_analysis", - "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.4/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.advanced_security", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.advanced_security.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning", - "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning_push_protection", - "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning_push_protection.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "has_issues", "description": "Either `true` to enable issues for this repository or `false` to disable them.", @@ -47128,19 +47349,6 @@ "alias": null, "deprecated": null }, - { - "name": "allow_auto_merge", - "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "delete_branch_on_merge", "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", @@ -47234,7 +47442,7 @@ }, { "name": "archived", - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "description": "Whether to archive this repository. **Note**: You cannot unarchive repositories through the API.", "in": "BODY", "type": "boolean", "required": false, @@ -47288,8 +47496,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "deprecationDate": 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\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#update-branch-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#update-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -47321,7 +47529,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -47503,7 +47711,7 @@ }, { "name": "required_pull_request_reviews.require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.4/articles/about-code-owners/) review them.", "in": "BODY", "type": "boolean", "required": false, @@ -47633,7 +47841,7 @@ }, { "name": "required_linear_history", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", + "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.4/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -47646,7 +47854,7 @@ }, { "name": "allow_force_pushes", - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", + "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.4/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", "in": "BODY", "type": "boolean", "required": false, @@ -47659,7 +47867,7 @@ }, { "name": "allow_deletions", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", + "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.4/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -47897,7 +48105,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, - "description": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).", + "description": "Updates information for a GitHub Enterprise Server 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 `administrative:write` and `pages:write` permissions.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/pages#update-information-about-a-github-pages-site", "previews": [], "headers": [], @@ -47930,7 +48138,7 @@ }, { "name": "cname", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.4/articles/using-a-custom-domain-with-github-pages/).\"", "in": "BODY", "type": "string", "required": false, @@ -47954,19 +48162,6 @@ "alias": null, "deprecated": null }, - { - "name": "public", - "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "build_type", "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", @@ -48094,8 +48289,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "deprecationDate": 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\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#update-pull-request-review-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#update-pull-request-review-protection", "previews": [], "headers": [], "parameters": [ @@ -48127,7 +48322,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -48205,7 +48400,7 @@ }, { "name": "require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.4/articles/about-code-owners/) have reviewed.", "in": "BODY", "type": "boolean", "required": false, @@ -48557,8 +48752,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": 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\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#update-status-check-protection", + "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/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/branches/branch-protection#update-status-check-protection", "previews": [], "headers": [], "parameters": [ @@ -48590,7 +48785,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.4/graphql).", "in": "PATH", "type": "string", "required": true, @@ -49250,7 +49445,7 @@ "url": "/search/commits", "isDeprecated": false, "deprecationDate": null, - "description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/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/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/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/enterprise-server@3.4/rest/reference/search#search-commits", "previews": [], "headers": [], @@ -49343,7 +49538,7 @@ "url": "/search/issues", "isDeprecated": false, "deprecationDate": null, - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/enterprise-server@3.4/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.4/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/search#search-issues-and-pull-requests", "previews": [], "headers": [], @@ -49575,7 +49770,7 @@ "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.4/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.4/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.4/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "QUERY", "type": "string", "required": true, @@ -49667,7 +49862,7 @@ "url": "/search/topics", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", + "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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#pagination). See \"[Searching topics](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/search#search-topics", "previews": [], "headers": [], @@ -49978,7 +50173,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results before this cursor.", "in": "QUERY", "type": "string", "required": false, @@ -49991,7 +50186,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results after this cursor.", "in": "QUERY", "type": "string", "required": false, @@ -50464,7 +50659,7 @@ "url": "/teams/{team_id}/members/{username}", "isDeprecated": true, "deprecationDate": "2020-01-21", - "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/enterprise-server@3.4/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](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/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.4/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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-verbs).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams#add-team-member-legacy", "previews": [], "headers": [], @@ -50520,7 +50715,7 @@ "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.4/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams#add-or-update-team-membership-for-a-user", "previews": [], "headers": [], @@ -50609,7 +50804,7 @@ "url": "/teams/{team_id}/memberships/{username}", "isDeprecated": true, "deprecationDate": "2020-01-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 [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.4/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.4/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.4/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy", "previews": [], "headers": [], @@ -50839,7 +51034,7 @@ "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "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/enterprise-server@3.4/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/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/teams/#add-or-update-team-repository-permissions", "previews": [], "headers": [], @@ -50922,7 +51117,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-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 \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.4/rest/reference/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams/#add-or-update-team-repository-permissions-legacy", + "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams#add-or-update-team-repository-permissions-legacy", "previews": [], "headers": [], "parameters": [ @@ -51292,7 +51487,7 @@ "url": "/orgs/{org}/teams", "isDeprecated": false, "deprecationDate": null, - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-server@3.4/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.4/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams#create-a-team", "previews": [], "headers": [], @@ -51364,7 +51559,7 @@ }, { "name": "privacy", - "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", + "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n * `closed` - visible to all members of this organization. \nDefault for child team: `closed`", "in": "BODY", "type": "string", "required": false, @@ -51442,7 +51637,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "isDeprecated": false, "deprecationDate": null, - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams#create-a-discussion-comment", "previews": [], "headers": [], @@ -51521,7 +51716,7 @@ "url": "/teams/{team_id}/discussions/{discussion_number}/comments", "isDeprecated": true, "deprecationDate": "2020-01-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 a discussion comment](https://docs.github.com/enterprise-server@3.4/rest/reference/teams#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/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/teams#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/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams#create-a-discussion-comment-legacy", "previews": [], "headers": [], @@ -51587,7 +51782,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions", "isDeprecated": false, "deprecationDate": null, - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams#create-a-discussion", "previews": [], "headers": [], @@ -51679,7 +51874,7 @@ "url": "/teams/{team_id}/discussions", "isDeprecated": true, "deprecationDate": "2020-01-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 a discussion`](https://docs.github.com/enterprise-server@3.4/rest/reference/teams#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/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/reference/teams#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/enterprise-server@3.4/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.4/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/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams#create-a-discussion-legacy", "previews": [], "headers": [], @@ -53635,7 +53830,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] } @@ -53701,7 +53896,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] }, @@ -53717,7 +53912,7 @@ "url": "/teams/{team_id}/members/{username}", "isDeprecated": true, "deprecationDate": "2020-01-21", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.4/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.4/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.4/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams#remove-team-member-legacy", "previews": [], "headers": [], @@ -53767,7 +53962,7 @@ "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.4/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams#remove-team-membership-for-a-user", "previews": [], "headers": [], @@ -53830,7 +54025,7 @@ "url": "/teams/{team_id}/memberships/{username}", "isDeprecated": true, "deprecationDate": "2020-01-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 [Remove team membership for a user](https://docs.github.com/enterprise-server@3.4/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.4/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.4/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.4/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/teams#remove-team-membership-for-a-user-legacy", "previews": [], "headers": [], @@ -54513,7 +54708,7 @@ }, { "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", "in": "BODY", "type": "string", "required": false, @@ -54634,7 +54829,7 @@ }, { "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", "in": "BODY", "type": "string", "required": false, diff --git a/scripts/update-endpoints/generated/ghe35-endpoints.json b/scripts/update-endpoints/generated/ghe35-endpoints.json index 69a28094..89d9262f 100644 --- a/scripts/update-endpoints/generated/ghe35-endpoints.json +++ b/scripts/update-endpoints/generated/ghe35-endpoints.json @@ -294,7 +294,7 @@ "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/actions#create-or-update-an-environment-secret", "previews": [], "headers": [], @@ -493,7 +493,7 @@ "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/actions#create-or-update-a-repository-secret", "previews": [], "headers": [], @@ -772,7 +772,7 @@ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", "isDeprecated": false, "deprecationDate": 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\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/enterprise-server@3.5/articles/creating-a-personal-access-token-for-the-command-line).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/actions#create-a-workflow-dispatch-event", "previews": [], "headers": [], @@ -3040,7 +3040,7 @@ "url": "/repos/{owner}/{repo}/actions/permissions/access", "isDeprecated": false, "deprecationDate": 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 internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.5/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories.\nFor more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.5/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/actions#get-workflow-access-level-to-a-repository", "previews": [], "headers": [], @@ -3316,6 +3316,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "name", + "description": "Filters artifacts by exact match on their name field.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -4521,7 +4534,7 @@ }, { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.5/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "QUERY", "type": "string", "required": false, @@ -4705,7 +4718,7 @@ }, { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.5/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "QUERY", "type": "string", "required": false, @@ -6082,7 +6095,7 @@ }, { "name": "selected_repository_ids", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.5/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.5/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", "in": "BODY", "type": "integer[]", "required": true, @@ -6148,7 +6161,7 @@ "url": "/repos/{owner}/{repo}/actions/permissions/access", "isDeprecated": false, "deprecationDate": 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 internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.5/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", + "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories.\nFor more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.5/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/actions#set-workflow-access-to-a-repository", "previews": [], "headers": [], @@ -6181,7 +6194,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. `none` means access is only possible from workflows in this repository.", + "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. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", "in": "BODY", "type": "string", "required": true, @@ -6315,7 +6328,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -6432,14 +6445,14 @@ "url": "/notifications/threads/{thread_id}", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Gets information about a notification thread.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/activity#get-a-thread", "previews": [], "headers": [], "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -6486,7 +6499,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -7270,7 +7283,7 @@ "url": "/repos/{owner}/{repo}/notifications", "isDeprecated": false, "deprecationDate": null, - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-repository-notifications-for-the-authenticated-user", "previews": [], "headers": [], @@ -7639,7 +7652,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] } @@ -7779,7 +7792,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] }, @@ -7880,7 +7893,7 @@ "url": "/notifications", "isDeprecated": false, "deprecationDate": null, - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/activity#mark-notifications-as-read", "previews": [], "headers": [], @@ -7941,7 +7954,7 @@ "url": "/repos/{owner}/{repo}/notifications", "isDeprecated": false, "deprecationDate": null, - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/activity#mark-repository-notifications-as-read", "previews": [], "headers": [], @@ -7987,7 +8000,15 @@ } ], "responses": [ - { "code": 202, "description": "Response", "examples": null }, + { + "code": 202, + "description": "Response", + "examples": [ + { + "data": "{\"message\":\"Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background.\"}" + } + ] + }, { "code": 205, "description": "Reset Content", "examples": null } ], "renamed": null @@ -8000,14 +8021,14 @@ "url": "/notifications/threads/{thread_id}", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/activity#mark-a-thread-as-read", "previews": [], "headers": [], "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -8120,7 +8141,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.5/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -9128,7 +9149,7 @@ "url": "/apps/{app_slug}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.5/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/enterprise-server@3.5/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/enterprise-server@3.5/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/apps/#get-an-app", "previews": [], "headers": [], @@ -9717,6 +9738,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "redelivery", + "description": "", + "in": "QUERY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -9767,7 +9801,11 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 400, "description": "Bad Request", "examples": null }, { "code": 400, "description": "Bad Request", "examples": null }, { @@ -11591,7 +11629,11 @@ } ], "responses": [ - { "code": 201, "description": "Response", "examples": null }, + { + "code": 201, + "description": "Response", + "examples": [{ "data": "null" }] + }, { "code": 403, "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App", @@ -11659,7 +11701,13 @@ "deprecated": null } ], - "responses": [{ "code": 201, "description": "Response", "examples": null }], + "responses": [ + { + "code": 201, + "description": "Response", + "examples": [{ "data": "null" }] + } + ], "renamed": null }, { @@ -11703,7 +11751,7 @@ }, { "name": "auto_trigger_checks", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "in": "BODY", "type": "object[]", "required": false, @@ -11908,7 +11956,7 @@ }, { "name": "output", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "in": "BODY", "type": "object", "required": false, @@ -11960,7 +12008,7 @@ }, { "name": "output.annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-server@3.5/articles/about-status-checks#checks)\".", "in": "BODY", "type": "object[]", "required": false, @@ -11986,7 +12034,7 @@ }, { "name": "output.annotations[].start_line", - "description": "The start line of the annotation.", + "description": "The start line of the annotation. Line numbers start at 1.", "in": "BODY", "type": "integer", "required": true, @@ -12012,7 +12060,7 @@ }, { "name": "output.annotations[].start_column", - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1.", "in": "BODY", "type": "integer", "required": false, @@ -12090,7 +12138,7 @@ }, { "name": "output.images", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.5/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "in": "BODY", "type": "object[]", "required": false, @@ -12693,7 +12741,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results before this cursor.", "in": "QUERY", "type": "string", "required": false, @@ -12706,7 +12754,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results after this cursor.", "in": "QUERY", "type": "string", "required": false, @@ -12793,11 +12841,6 @@ } ] }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, { "code": 404, "description": "Resource not found", "examples": null }, { "code": 503, "description": "Service unavailable", "examples": null } ], @@ -13330,7 +13373,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/sarifs", "isDeprecated": false, "deprecationDate": 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.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n- If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n- If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n
\nSARIF upload supports a maximum 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).\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 15 | |\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| 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\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/reference/code-scanning#get-information-about-a-sarif-upload).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/code-scanning#upload-a-sarif-file", "previews": [], "headers": [], @@ -13720,7 +13763,7 @@ "url": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository\npermission to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository\npermission to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/dependabot#create-or-update-a-repository-secret", "previews": [], "headers": [], @@ -14623,7 +14666,7 @@ "url": "{origin}/setup/api/start", "isDeprecated": false, "deprecationDate": null, - "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.5/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", + "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.5/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/enterprise-admin#create-a-github-enterprise-server-license", "previews": [], "headers": [], @@ -14846,7 +14889,7 @@ "description": "A list of [scopes](https://docs.github.com/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "in": "BODY", "type": "string[]", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -15685,7 +15728,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Gets the current message and expiration date of the global announcement banner in your enterprise.", - "documentationUrl": "", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/enterprise-admin/announcement#get-the-global-announcement-banner", "previews": [], "headers": [], "parameters": [], @@ -15695,7 +15738,7 @@ "description": "Response", "examples": [ { - "data": "{\"announcement\":\"Very **important** announcement about _nothing_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\"}" + "data": "{\"announcement\":\"Very **important** announcement about _something_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\",\"user_dismissible\":false}" } ] } @@ -15715,7 +15758,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_commit_comments\":5000,\"total_gist_comments\":400,\"total_issue_comments\":10900,\"total_pull_request_comments\":9900}" + } + ] + } + ], "renamed": null }, { @@ -15811,7 +15864,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_gists\":500,\"private_gists\":30,\"public_gists\":470}" + } + ] + } + ], "renamed": null }, { @@ -15907,7 +15970,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_hooks\":50,\"active_hooks\":47,\"inactive_hooks\":3}" + } + ] + } + ], "renamed": null }, { @@ -15923,7 +15996,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_issues\":5000,\"open_issues\":300,\"closed_issues\":4700}" + } + ] + } + ], "renamed": null }, { @@ -16005,7 +16088,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_milestones\":90,\"open_milestones\":10,\"closed_milestones\":80}" + } + ] + } + ], "renamed": null }, { @@ -16021,7 +16114,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_orgs\":50,\"disabled_orgs\":1,\"total_teams\":70,\"total_team_members\":700}" + } + ] + } + ], "renamed": null }, { @@ -16037,7 +16140,13 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [{ "data": "{\"total_pages\":20}" }] + } + ], "renamed": null }, { @@ -16252,7 +16361,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_pulls\":1200,\"merged_pulls\":1100,\"mergeable_pulls\":90,\"unmergeable_pulls\":10}" + } + ] + } + ], "renamed": null }, { @@ -16268,7 +16387,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_repos\":200,\"root_repos\":1,\"fork_repos\":10,\"org_repos\":150,\"total_pushes\":39000,\"total_wikis\":5}" + } + ] + } + ], "renamed": null }, { @@ -16324,7 +16453,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_users\":100,\"admin_users\":3,\"suspended_users\":1}" + } + ] + } + ], "renamed": null }, { @@ -17128,7 +17267,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Removes the global announcement banner in your enterprise.", - "documentationUrl": "", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/enterprise-admin/announcement#remove-the-global-announcement-banner", "previews": [], "headers": [], "parameters": [], @@ -17444,7 +17583,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Sets the message and expiration time for the global announcement banner in your enterprise.", - "documentationUrl": "", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/enterprise-admin/announcement#set-the-global-announcement-banner", "previews": [], "headers": [], "parameters": [ @@ -17455,7 +17594,7 @@ "type": "string", "required": true, "enum": null, - "allowNull": false, + "allowNull": true, "mapToData": null, "validation": null, "alias": null, @@ -17481,7 +17620,7 @@ "description": "Response", "examples": [ { - "data": "{\"announcement\":\"Very **important** announcement about _nothing_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\"}" + "data": "{\"announcement\":\"Very **important** announcement about _something_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\",\"user_dismissible\":false}" } ] } @@ -18667,7 +18806,7 @@ "url": "{origin}/setup/api/upgrade", "isDeprecated": false, "deprecationDate": null, - "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", + "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/enterprise-admin#upgrade-a-license", "previews": [], "headers": [], @@ -18830,7 +18969,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" } ] }, @@ -19065,7 +19204,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" } ] }, @@ -19177,7 +19316,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" } ] }, @@ -19774,7 +19913,7 @@ "url": "/gists/{gist_id}", "isDeprecated": false, "deprecationDate": null, - "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", + "description": "Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/gists/#update-a-gist", "previews": [], "headers": [], @@ -19794,7 +19933,7 @@ }, { "name": "description", - "description": "Description of the gist", + "description": "The description of the gist.", "in": "BODY", "type": "string", "required": false, @@ -19807,7 +19946,7 @@ }, { "name": "files", - "description": "Names of files to be updated", + "description": "The gist files to be updated, renamed, or deleted. Each `key` must match the current filename\n(including extension) of the targeted gist file. For example: `hello.py`.\n\nTo delete a file, set the whole file to null. For example: `hello.py : null`.", "in": "BODY", "type": "object", "required": false, @@ -19833,7 +19972,7 @@ }, { "name": "files.*.content", - "description": "The new content of the file", + "description": "The new content of the file.", "in": "BODY", "type": "string", "required": false, @@ -19846,7 +19985,7 @@ }, { "name": "files.*.filename", - "description": "The new filename for the file", + "description": "The new filename for the file.", "in": "BODY", "type": "string", "required": false, @@ -19864,7 +20003,13 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" + }, + { + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":null,\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"A gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"9cc352a89178a6d4\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":1,\"additions\":0,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" + }, + { + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"goodbye.py\":{\"filename\":\"goodbye.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/8481a81af6b7a2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/goodbye.py\",\"size\":4,\"truncated\":false,\"content\":\"# Hello world\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"A gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":0,\"additions\":0,\"deletions\":0},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" } ] }, @@ -21558,6 +21703,86 @@ ], "renamed": null }, + { + "name": "Check if a user can be assigned to a issue", + "scope": "issues", + "id": "checkUserCanBeAssignedToIssue", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/issues#check-if-a-user-can-be-assigned-to-a-issue", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "assignee", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 204, + "description": "Response if `assignee` can be assigned to `issue_number`", + "examples": null + }, + { + "code": 404, + "description": "Response if `assignee` can not be assigned to `issue_number`", + "examples": null + } + ], + "renamed": null + }, { "name": "Create an issue", "scope": "issues", @@ -21566,7 +21791,7 @@ "url": "/repos/{owner}/{repo}/issues", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/issues#create-an-issue", "previews": [], "headers": [], @@ -22173,7 +22398,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}", "isDeprecated": false, "deprecationDate": null, - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/issues#get-an-issue", "previews": [], "headers": [], @@ -22513,7 +22738,7 @@ "url": "/issues", "isDeprecated": false, "deprecationDate": 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 v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/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\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/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/issues#list-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], @@ -22710,7 +22935,7 @@ "url": "/repos/{owner}/{repo}/assignees", "isDeprecated": false, "deprecationDate": null, - "description": "Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "description": "Lists the [available assignees](https://docs.github.com/enterprise-server@3.5/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/issues#list-assignees", "previews": [], "headers": [], @@ -23292,7 +23517,7 @@ "url": "/user/issues", "isDeprecated": false, "deprecationDate": null, - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/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/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], @@ -23432,7 +23657,7 @@ "url": "/orgs/{org}/issues", "isDeprecated": false, "deprecationDate": null, - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/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/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], @@ -23584,7 +23809,7 @@ "url": "/repos/{owner}/{repo}/issues", "isDeprecated": false, "deprecationDate": null, - "description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/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/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/issues#list-repository-issues", "previews": [], "headers": [], @@ -24219,7 +24444,7 @@ }, { "name": "lock_reason", - "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", + "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`", "in": "BODY", "type": "string", "required": false, @@ -24635,7 +24860,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Issue owners and users with push access can edit an issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/issues/#update-an-issue", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/issues#update-an-issue", "previews": [], "headers": [], "parameters": [ @@ -25330,7 +25555,11 @@ } ], "responses": [ - { "code": 200, "description": "Response", "examples": null }, + { + "code": 200, + "description": "Response", + "examples": [{ "data": "\"

Hello world

\"" }] + }, { "code": 304, "description": "Not modified", "examples": null } ], "renamed": null @@ -25365,7 +25594,11 @@ } ], "responses": [ - { "code": 200, "description": "Response", "examples": null }, + { + "code": 200, + "description": "Response", + "examples": [{ "data": "\"

Hello world

\"" }] + }, { "code": 304, "description": "Not modified", "examples": null } ], "renamed": null @@ -25446,7 +25679,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Get a random sentence from the Zen of GitHub", - "documentationUrl": "", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/meta#get-the-zen-of-github", "previews": [], "headers": [], "parameters": [], @@ -25789,7 +26022,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] }, @@ -25856,7 +26089,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] }, @@ -26309,7 +26542,7 @@ "url": "/orgs/{org}/outside_collaborators/{username}", "isDeprecated": false, "deprecationDate": null, - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.5/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://docs.github.com/enterprise-server@3.5/articles/converting-an-organization-member-to-an-outside-collaborator/)\". Converting an organization member to an outside collaborator may be restricted by enterprise administrators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.5/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator", "previews": [], "headers": [], @@ -26363,7 +26596,7 @@ { "code": 204, "description": "User was converted", "examples": null }, { "code": 403, - "description": "Forbidden if user is the last owner of the organization or not a member of the organization.", + "description": "Forbidden if user is the last owner of the organization, not a member of the organization, or if the enterprise enforces a policy for inviting outside collaborators. For more information, see \"[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.5/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#enforcing-a-policy-for-inviting-outside-collaborators-to-repositories).\"", "examples": null }, { "code": 404, "description": "Resource not found", "examples": null } @@ -26502,7 +26735,7 @@ }, { "name": "events", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", "in": "BODY", "type": "string[]", "required": false, @@ -26600,7 +26833,7 @@ "url": "/orgs/{org}", "isDeprecated": false, "deprecationDate": 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 Enterprise Server plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@3.5/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"", + "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.5/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 Enterprise Server plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@3.5/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/orgs#get-an-organization", "previews": [], "headers": [], @@ -27038,7 +27271,7 @@ "url": "/organizations/{organization_id}/custom_roles", "isDeprecated": false, "deprecationDate": null, - "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", + "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organization and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/orgs#list-custom-repository-roles-in-an-organization", "previews": [], "headers": [], @@ -27138,7 +27371,7 @@ "url": "/users/{username}/orgs", "isDeprecated": false, "deprecationDate": null, - "description": "List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", + "description": "List [public organization memberships](https://docs.github.com/enterprise-server@3.5/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.5/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/orgs#list-organizations-for-a-user", "previews": [], "headers": [], @@ -27580,6 +27813,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "redelivery", + "description": "", + "in": "QUERY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -27769,7 +28015,11 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 400, "description": "Bad Request", "examples": null }, { "code": 400, "description": "Bad Request", "examples": null }, { @@ -28011,7 +28261,7 @@ }, { "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.", + "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, @@ -28097,7 +28347,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/orgs/#update-an-organization", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/orgs#update-an-organization", "previews": [], "headers": [], "parameters": [ @@ -28259,7 +28509,7 @@ }, { "name": "members_can_create_internal_repositories", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.5/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -28272,7 +28522,7 @@ }, { "name": "members_can_create_private_repositories", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.5/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -28285,7 +28535,7 @@ }, { "name": "members_can_create_public_repositories", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.5/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -29804,7 +30054,7 @@ "description": "Response", "examples": [ { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}]" + "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":true}]" } ] }, @@ -30536,7 +30786,7 @@ "url": "/repos/{owner}/{repo}/pulls", "isDeprecated": false, "deprecationDate": 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#create-a-pull-request", "previews": [], "headers": [], @@ -30621,7 +30871,7 @@ }, { "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.5/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", "in": "BODY", "type": "boolean", "required": false, @@ -30634,7 +30884,7 @@ }, { "name": "draft", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-server@3.5/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", "in": "BODY", "type": "boolean", "required": false, @@ -30665,7 +30915,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" } ] }, @@ -30686,7 +30936,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", "isDeprecated": false, "deprecationDate": 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#create-a-reply-for-a-review-comment", "previews": [], "headers": [], @@ -30779,7 +31029,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "isDeprecated": false, "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/pulls#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 v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/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": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/pulls#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/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/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.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#create-a-review-for-a-pull-request", "previews": [], "headers": [], @@ -30994,7 +31244,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.5/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.5/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#create-a-review-comment-for-a-pull-request", "previews": [], "headers": [], @@ -31092,7 +31342,7 @@ }, { "name": "side", - "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-server@3.5/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "in": "BODY", "type": "string", "required": false, @@ -31118,7 +31368,7 @@ }, { "name": "start_line", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.5/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", "in": "BODY", "type": "integer", "required": false, @@ -31131,7 +31381,7 @@ }, { "name": "start_side", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.5/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "in": "BODY", "type": "string", "required": false, @@ -31438,7 +31688,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.5/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server 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/enterprise-server@3.5/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 Enterprise Server 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/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server 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/enterprise-server@3.5/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 Enterprise Server 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/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#get-a-pull-request", "previews": [], "headers": [], @@ -31489,7 +31739,7 @@ "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.5/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" } ] }, @@ -31655,7 +31905,7 @@ "url": "/repos/{owner}/{repo}/pulls", "isDeprecated": false, "deprecationDate": 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": "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests", "previews": [], "headers": [], @@ -32594,7 +32844,7 @@ }, { "name": "merge_method", - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", + "description": "The merge method to use.", "in": "BODY", "type": "string", "required": false, @@ -32957,7 +33207,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/pulls/#update-a-pull-request", "previews": [], "headers": [], @@ -33055,7 +33305,7 @@ }, { "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.5/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", "in": "BODY", "type": "boolean", "required": false, @@ -33073,7 +33323,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" } ] }, @@ -35853,8 +36103,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#add-app-access-restrictions", + "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/enterprise-server@3.5/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.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#add-app-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -35886,7 +36136,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -36027,8 +36277,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#add-status-check-contexts", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#add-status-check-contexts", "previews": [], "headers": [], "parameters": [ @@ -36060,7 +36310,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -36113,8 +36363,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": 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 teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#add-team-access-restrictions", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#add-team-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -36146,7 +36396,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -36197,8 +36447,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": 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 people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#add-user-access-restrictions", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#add-user-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -36230,7 +36480,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -36522,7 +36772,7 @@ "url": "/repos/{owner}/{repo}/compare/{basehead}", "isDeprecated": false, "deprecationDate": null, - "description": "The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.5/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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\n**Working with large comparisons**\n\nTo process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"[Traversing with pagination](/rest/guides/traversing-with-pagination).\"\n\nWhen calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "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/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/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 her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/commits/commits#compare-two-commits", "previews": [], "headers": [], @@ -36581,7 +36831,7 @@ }, { "name": "basehead", - "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.", + "description": "The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`.", "in": "PATH", "type": "string", "required": true, @@ -36714,7 +36964,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", "isDeprecated": false, "deprecationDate": null, - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/commits/comments#create-a-commit-comment", "previews": [], "headers": [], @@ -36838,8 +37088,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#create-commit-signature-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#create-commit-signature-protection", "previews": [], "headers": [], "parameters": [ @@ -36871,7 +37121,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -37024,7 +37274,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "You can create a read-only deploy key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#create-a-deploy-key", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deploy-keys#create-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -37082,7 +37332,7 @@ }, { "name": "read_only", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.5/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.5/articles/permission-levels-for-a-user-account-repository/).\"", "in": "BODY", "type": "boolean", "required": false, @@ -37121,7 +37371,7 @@ "isDeprecated": false, "deprecationDate": 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 Enterprise Server 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/enterprise-server@3.5/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#create-a-deployment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deployments/deployments#create-a-deployment", "previews": [], "headers": [], "parameters": [ @@ -37402,7 +37652,7 @@ "isDeprecated": false, "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#create-a-deployment-status", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deployments/statuses#create-a-deployment-status", "previews": [], "headers": [], "parameters": [ @@ -37571,7 +37821,7 @@ "url": "/repos/{owner}/{repo}/dispatches", "isDeprecated": false, "deprecationDate": null, - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server 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/enterprise-server@3.5/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 Enterprise Server 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/enterprise-server@3.5/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/enterprise-server@3.5/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#create-a-repository-dispatch-event", "previews": [], "headers": [], @@ -37617,7 +37867,7 @@ }, { "name": "client_payload", - "description": "JSON payload with extra information about the webhook event that your action or workflow may use.", + "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.", "in": "BODY", "type": "object", "required": false, @@ -37756,6 +38006,19 @@ "alias": null, "deprecated": null }, + { + "name": "has_discussions", + "description": "Whether discussions are enabled.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "team_id", "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", @@ -38135,7 +38398,7 @@ }, { "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", + "description": "The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/enterprise-server@3.5/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "in": "BODY", "type": "string", "required": false, @@ -38185,6 +38448,19 @@ "alias": null, "deprecated": null }, + { + "name": "has_downloads", + "description": "Whether downloads are enabled.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "is_template", "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", @@ -38239,7 +38515,7 @@ }, { "name": "license_template", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.5/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", "in": "BODY", "type": "string", "required": false, @@ -38409,7 +38685,7 @@ "isDeprecated": false, "deprecationDate": 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 \"[Secrets](/rest/reference/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#create-or-update-an-environment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deployments/environments#create-or-update-an-environment", "previews": [], "headers": [], "parameters": [ @@ -38808,7 +39084,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, - "description": "Configures a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"", + "description": "Configures a GitHub Enterprise Server 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 `administrative:write` and `pages:write` permissions.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/pages#create-a-github-pages-site", "previews": [], "headers": [], @@ -38919,7 +39195,7 @@ "url": "/repos/{owner}/{repo}/releases", "isDeprecated": false, "deprecationDate": null, - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#create-a-release", "previews": [], "headers": [], @@ -39576,8 +39852,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "isDeprecated": false, "deprecationDate": 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\nDisables the ability to restrict who can push to this branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-access-restrictions", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#delete-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -39609,7 +39885,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -39632,8 +39908,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "deprecationDate": 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\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-admin-branch-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#delete-admin-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -39665,7 +39941,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -39692,7 +39968,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "You must authenticate using an access token with the repo scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-an-environment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deployments/environments#delete-an-environment", "previews": [], "headers": [], "parameters": [ @@ -39808,8 +40084,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-branch-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#delete-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -39841,7 +40117,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -39926,8 +40202,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-commit-signature-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#delete-commit-signature-protection", "previews": [], "headers": [], "parameters": [ @@ -39959,7 +40235,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -39986,7 +40262,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-a-deploy-key", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deploy-keys#delete-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -40041,8 +40317,8 @@ "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.5/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#create-a-deployment-status).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-a-deployment", + "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/enterprise-server@3.5/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.5/rest/deployments/deployment-statuses#create-a-deployment-status).\"", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deployments/deployments#delete-a-deployment", "previews": [], "headers": [], "parameters": [ @@ -40421,7 +40697,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Deletes a a GitHub Enterprise Server 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 `administrative:write` and `pages:write` permissions.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/pages#delete-a-github-pages-site", "previews": [], "headers": [], @@ -40473,8 +40749,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#delete-pull-request-review-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#delete-pull-request-review-protection", "previews": [], "headers": [], "parameters": [ @@ -40506,7 +40782,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -40763,7 +41039,7 @@ "url": "/repos/{owner}/{repo}/lfs", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#disable-git-lfs-for-a-repository", "previews": [], "headers": [], @@ -40806,7 +41082,7 @@ "url": "/repos/{owner}/{repo}/tarball/{ref}", "isDeprecated": false, "deprecationDate": null, - "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", + "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#download-a-repository-archive", "previews": [], "headers": [], @@ -40862,7 +41138,7 @@ "url": "/repos/{owner}/{repo}/zipball/{ref}", "isDeprecated": false, "deprecationDate": null, - "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", + "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#download-a-repository-archive", "previews": [], "headers": [], @@ -40918,7 +41194,7 @@ "url": "/repos/{owner}/{repo}/lfs", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#enable-git-lfs-for-a-repository", "previews": [], "headers": [], @@ -40951,7 +41227,11 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 403, "description": "We will return a 403 with one of the following messages:\n\n- Git LFS support not enabled because Git LFS is globally disabled.\n- Git LFS support not enabled because Git LFS is disabled for the root repository in the network.\n- Git LFS support not enabled because Git LFS is disabled for .", @@ -41074,7 +41354,7 @@ "url": "/repos/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-a-repository", "previews": [], "headers": [], @@ -41112,7 +41392,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\":{\"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}}" + "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\"}}}}" } ] }, @@ -41130,8 +41410,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "isDeprecated": false, "deprecationDate": 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 who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-access-restrictions", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -41163,7 +41443,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -41197,8 +41477,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-admin-branch-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-admin-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -41230,7 +41510,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -41342,8 +41622,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-all-status-check-contexts", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-all-status-check-contexts", "previews": [], "headers": [], "parameters": [ @@ -41375,7 +41655,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -41483,8 +41763,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-apps-with-access-to-the-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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -41516,7 +41796,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -41618,7 +41898,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-a-branch", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branches#get-a-branch", "previews": [], "headers": [], "parameters": [ @@ -41650,7 +41930,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -41685,8 +41965,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-branch-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -41718,7 +41998,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -41790,7 +42070,11 @@ "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", "examples": [{ "data": "[[1302998400,1124,-435]]" }] }, - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 204, "description": "A header with no content is returned.", @@ -42109,7 +42393,11 @@ } ] }, - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 204, "description": "A header with no content is returned.", @@ -42193,8 +42481,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-commit-signature-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.5/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-commit-signature-protection", "previews": [], "headers": [], "parameters": [ @@ -42226,7 +42514,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -42319,13 +42607,24 @@ } ], "responses": [ - { "code": 200, "description": "Response", "examples": null }, { "code": 200, "description": "Response", "examples": [ { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" + "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\\\nIHdvcmtmbG93Lgo=\\\\n\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" + }, + { + "data": "{\"type\":\"dir\",\"size\":0,\"name\":\"src\",\"path\":\"src\",\"sha\":\"2962be1c94eaae9794b3080790ec9d74b2fa8358\",\"url\":\"https://api.github.com/repos/octocat/octorepo/contents/src?ref=main\",\"git_url\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octocat/octorepo/blob/main/src\",\"download_url\":\"https://raw.githubusercontent.com/octocat/octorepo/main/src\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/octorepo/contents/src\",\"git\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octocat/octorepo/blob/main/src\"},\"entries\":[{\"type\":\"file\",\"size\":625,\"name\":\"app.js\",\"path\":\"src/app.js\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octocat/octorepo/contents/src/app.js\",\"git_url\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octocat/octorepo/blob/main/src/app.js\",\"download_url\":\"https://raw.githubusercontent.com/octocat/octorepo/main/src/app.js\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/octorepo/contents/src/app.js\",\"git\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octocat/octorepo/blob/main/src/app.js\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"images\",\"path\":\"src/images\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octocat/octorepo/contents/src/images\",\"git_url\":\"https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octocat/octorepo/tree/main/src/images\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octocat/octorepo/contents/src/images\",\"git\":\"https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octocat/octorepo/tree/main/src/images\"}}]}" + } + ] + }, + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\\\nIHdvcmtmbG93Lgo=\\\\n\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" }, { "data": "[{\"type\":\"file\",\"size\":625,\"name\":\"octokit.rb\",\"path\":\"lib/octokit.rb\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb\",\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"octokit\",\"path\":\"lib/octokit\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\"}}]" @@ -42394,7 +42693,11 @@ } ] }, - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 204, "description": "A header with no content is returned.", @@ -42412,7 +42715,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-a-deploy-key", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deploy-keys#get-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -42479,7 +42782,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-a-deployment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deployments/deployments#get-a-deployment", "previews": [], "headers": [], "parameters": [ @@ -42625,7 +42928,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Users with pull access can view a deployment status for a deployment:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-a-deployment-status", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deployments/statuses#get-a-deployment-status", "previews": [], "headers": [], "parameters": [ @@ -42705,7 +43008,7 @@ "isDeprecated": false, "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-an-environment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deployments/environments#get-an-environment", "previews": [], "headers": [], "parameters": [ @@ -43050,8 +43353,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-pull-request-review-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-pull-request-review-protection", "previews": [], "headers": [], "parameters": [ @@ -43083,7 +43386,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -43529,8 +43832,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-status-checks-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#get-status-checks-protection", "previews": [], "headers": [], "parameters": [ @@ -43562,7 +43865,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -43596,8 +43899,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": 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 teams who have push access to this branch. The list includes child teams.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-teams-with-access-to-the-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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -43629,7 +43932,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -43663,8 +43966,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": 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 people who have push access to this branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-users-with-access-to-the-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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -43696,7 +43999,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -44016,7 +44319,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-branches", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branches#list-branches", "previews": [], "headers": [], "parameters": [ @@ -44108,7 +44411,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "isDeprecated": false, "deprecationDate": 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\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/commits/commits#list-branches-for-head-commit", "previews": [], "headers": [], @@ -44304,19 +44607,6 @@ "alias": null, "deprecated": null }, - { - "name": "permission", - "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["pull", "triage", "push", "maintain", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "per_page", "description": "The number of results per page (max 100).", @@ -44663,7 +44953,7 @@ }, { "name": "sha", - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).", "in": "QUERY", "type": "string", "required": false, @@ -44779,7 +45069,7 @@ "url": "/repos/{owner}/{repo}/contributors", "isDeprecated": false, "deprecationDate": null, - "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", + "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-repository-contributors", "previews": [], "headers": [], @@ -44879,7 +45169,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-deploy-keys", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deploy-keys#list-deploy-keys", "previews": [], "headers": [], "parameters": [ @@ -45042,7 +45332,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Users with pull access can view deployment statuses for a deployment:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-deployment-statuses", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deployments/statuses#list-deployment-statuses", "previews": [], "headers": [], "parameters": [ @@ -45135,7 +45425,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Simple filtering of deployments is available via query parameters:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#list-deployments", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/deployments/deployments#list-deployments", "previews": [], "headers": [], "parameters": [ @@ -45285,7 +45575,7 @@ }, { "name": "affiliation", - "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", + "description": "Comma-separated list of values. Can include: \n * `owner`: Repositories that are owned by the authenticated user. \n * `collaborator`: Repositories that the user has been added to as a collaborator. \n * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", "in": "QUERY", "type": "string", "required": false, @@ -45441,7 +45731,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token.", + "description": "Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation access token.", "in": "QUERY", "type": "string", "required": false, @@ -45519,7 +45809,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] } @@ -45624,7 +45914,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] } @@ -46060,7 +46350,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "isDeprecated": false, "deprecationDate": null, - "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.", + "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/commits/commits#list-pull-requests-associated-with-a-commit", "previews": [], "headers": [], @@ -46602,6 +46892,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "redelivery", + "description": "", + "in": "QUERY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -46713,7 +47016,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#merge-a-branch", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branches#merge-a-branch", "previews": [], "headers": [], "parameters": [ @@ -46826,7 +47129,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository", "previews": [], "headers": [], "parameters": [ @@ -47019,7 +47322,11 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 400, "description": "Bad Request", "examples": null }, { "code": 400, "description": "Bad Request", "examples": null }, { @@ -47038,8 +47345,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#remove-app-access-restrictions", + "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/enterprise-server@3.5/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.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#remove-app-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -47071,7 +47378,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -47178,8 +47485,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#remove-status-check-contexts", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#remove-status-check-contexts", "previews": [], "headers": [], "parameters": [ @@ -47211,7 +47518,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -47259,8 +47566,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#remove-status-check-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#remove-status-check-protection", "previews": [], "headers": [], "parameters": [ @@ -47292,7 +47599,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -47315,8 +47622,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": 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 a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#remove-team-access-restrictions", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#remove-team-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -47348,7 +47655,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -47399,8 +47706,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": 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 a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#remove-user-access-restrictions", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#remove-user-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -47432,7 +47739,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -47484,7 +47791,7 @@ "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.5/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#rename-a-branch", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branches#rename-a-branch", "previews": [], "headers": [], "parameters": [ @@ -47516,7 +47823,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -47692,8 +47999,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "deprecationDate": 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\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#set-admin-branch-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#set-admin-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -47725,7 +48032,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -47758,8 +48065,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#set-app-access-restrictions", + "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/enterprise-server@3.5/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.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#set-app-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -47791,7 +48098,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -47842,8 +48149,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#set-status-check-contexts", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#set-status-check-contexts", "previews": [], "headers": [], "parameters": [ @@ -47875,7 +48182,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -47923,8 +48230,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": 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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#set-team-access-restrictions", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#set-team-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -47956,7 +48263,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -48007,8 +48314,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": 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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#set-user-access-restrictions", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#set-user-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -48040,7 +48347,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -48150,7 +48457,7 @@ "url": "/repos/{owner}/{repo}/transfer", "isDeprecated": false, "deprecationDate": 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/).", + "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/enterprise-server@3.5/articles/about-repository-transfers/).", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#transfer-a-repository", "previews": [], "headers": [], @@ -48230,7 +48537,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#replace-all-repository-topics) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos/#update-a-repository", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/repos/repos#update-a-repository", "previews": [], "headers": [], "parameters": [ @@ -48301,7 +48608,7 @@ }, { "name": "private", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.5/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "in": "BODY", "type": "boolean", "required": false, @@ -48314,7 +48621,7 @@ }, { "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"", + "description": "The visibility of the repository.", "in": "BODY", "type": "string", "required": false, @@ -48325,97 +48632,6 @@ "alias": null, "deprecated": null }, - { - "name": "security_and_analysis", - "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.5/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.advanced_security", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.advanced_security.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning", - "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning_push_protection", - "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning_push_protection.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "has_issues", "description": "Either `true` to enable issues for this repository or `false` to disable them.", @@ -48520,19 +48736,6 @@ "alias": null, "deprecated": null }, - { - "name": "allow_auto_merge", - "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "delete_branch_on_merge", "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", @@ -48626,7 +48829,7 @@ }, { "name": "archived", - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "description": "Whether to archive this repository. **Note**: You cannot unarchive repositories through the API.", "in": "BODY", "type": "boolean", "required": false, @@ -48680,8 +48883,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "deprecationDate": 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\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#update-branch-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#update-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -48713,7 +48916,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -48895,7 +49098,7 @@ }, { "name": "required_pull_request_reviews.require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.5/articles/about-code-owners/) review them.", "in": "BODY", "type": "boolean", "required": false, @@ -49025,7 +49228,7 @@ }, { "name": "required_linear_history", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", + "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.5/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -49038,7 +49241,7 @@ }, { "name": "allow_force_pushes", - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", + "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.5/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", "in": "BODY", "type": "boolean", "required": false, @@ -49051,7 +49254,7 @@ }, { "name": "allow_deletions", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", + "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.5/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -49289,7 +49492,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, - "description": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).", + "description": "Updates information for a GitHub Enterprise Server 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 `administrative:write` and `pages:write` permissions.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/pages#update-information-about-a-github-pages-site", "previews": [], "headers": [], @@ -49322,7 +49525,7 @@ }, { "name": "cname", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.5/articles/using-a-custom-domain-with-github-pages/).\"", "in": "BODY", "type": "string", "required": false, @@ -49346,19 +49549,6 @@ "alias": null, "deprecated": null }, - { - "name": "public", - "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "build_type", "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", @@ -49486,8 +49676,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "deprecationDate": 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\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#update-pull-request-review-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#update-pull-request-review-protection", "previews": [], "headers": [], "parameters": [ @@ -49519,7 +49709,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -49597,7 +49787,7 @@ }, { "name": "require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.5/articles/about-code-owners/) have reviewed.", "in": "BODY", "type": "boolean", "required": false, @@ -49949,8 +50139,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": 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\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#update-status-check-protection", + "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/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/branches/branch-protection#update-status-check-protection", "previews": [], "headers": [], "parameters": [ @@ -49982,7 +50172,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.5/graphql).", "in": "PATH", "type": "string", "required": true, @@ -50642,7 +50832,7 @@ "url": "/search/commits", "isDeprecated": false, "deprecationDate": null, - "description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/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/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/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/enterprise-server@3.5/rest/reference/search#search-commits", "previews": [], "headers": [], @@ -50735,7 +50925,7 @@ "url": "/search/issues", "isDeprecated": false, "deprecationDate": null, - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/enterprise-server@3.5/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.5/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/search#search-issues-and-pull-requests", "previews": [], "headers": [], @@ -50967,7 +51157,7 @@ "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.5/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.5/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.5/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "QUERY", "type": "string", "required": true, @@ -51059,7 +51249,7 @@ "url": "/search/topics", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", + "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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#pagination). See \"[Searching topics](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/search#search-topics", "previews": [], "headers": [], @@ -51370,7 +51560,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results before this cursor.", "in": "QUERY", "type": "string", "required": false, @@ -51383,7 +51573,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results after this cursor.", "in": "QUERY", "type": "string", "required": false, @@ -51856,7 +52046,7 @@ "url": "/teams/{team_id}/members/{username}", "isDeprecated": true, "deprecationDate": "2020-01-21", - "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/enterprise-server@3.5/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](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/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.5/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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#http-verbs).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#add-team-member-legacy", "previews": [], "headers": [], @@ -51912,7 +52102,7 @@ "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.5/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#add-or-update-team-membership-for-a-user", "previews": [], "headers": [], @@ -52001,7 +52191,7 @@ "url": "/teams/{team_id}/memberships/{username}", "isDeprecated": true, "deprecationDate": "2020-01-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 [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.5/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.5/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.5/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy", "previews": [], "headers": [], @@ -52231,7 +52421,7 @@ "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "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/enterprise-server@3.5/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/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/teams/#add-or-update-team-repository-permissions", "previews": [], "headers": [], @@ -52314,7 +52504,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-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 \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.5/rest/reference/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams/#add-or-update-team-repository-permissions-legacy", + "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#add-or-update-team-repository-permissions-legacy", "previews": [], "headers": [], "parameters": [ @@ -52684,7 +52874,7 @@ "url": "/orgs/{org}/teams", "isDeprecated": false, "deprecationDate": null, - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-server@3.5/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.5/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#create-a-team", "previews": [], "headers": [], @@ -52756,7 +52946,7 @@ }, { "name": "privacy", - "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", + "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n * `closed` - visible to all members of this organization. \nDefault for child team: `closed`", "in": "BODY", "type": "string", "required": false, @@ -52834,7 +53024,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "isDeprecated": false, "deprecationDate": null, - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#create-a-discussion-comment", "previews": [], "headers": [], @@ -52913,7 +53103,7 @@ "url": "/teams/{team_id}/discussions/{discussion_number}/comments", "isDeprecated": true, "deprecationDate": "2020-01-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 a discussion comment](https://docs.github.com/enterprise-server@3.5/rest/reference/teams#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/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/teams#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/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#create-a-discussion-comment-legacy", "previews": [], "headers": [], @@ -52979,7 +53169,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions", "isDeprecated": false, "deprecationDate": null, - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#create-a-discussion", "previews": [], "headers": [], @@ -53071,7 +53261,7 @@ "url": "/teams/{team_id}/discussions", "isDeprecated": true, "deprecationDate": "2020-01-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 a discussion`](https://docs.github.com/enterprise-server@3.5/rest/reference/teams#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/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/reference/teams#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/enterprise-server@3.5/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.5/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/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#create-a-discussion-legacy", "previews": [], "headers": [], @@ -55027,7 +55217,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] } @@ -55093,7 +55283,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] }, @@ -55109,7 +55299,7 @@ "url": "/teams/{team_id}/members/{username}", "isDeprecated": true, "deprecationDate": "2020-01-21", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.5/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.5/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.5/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#remove-team-member-legacy", "previews": [], "headers": [], @@ -55159,7 +55349,7 @@ "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.5/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#remove-team-membership-for-a-user", "previews": [], "headers": [], @@ -55222,7 +55412,7 @@ "url": "/teams/{team_id}/memberships/{username}", "isDeprecated": true, "deprecationDate": "2020-01-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 [Remove team membership for a user](https://docs.github.com/enterprise-server@3.5/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.5/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.5/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.5/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/teams#remove-team-membership-for-a-user-legacy", "previews": [], "headers": [], @@ -55905,7 +56095,7 @@ }, { "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", "in": "BODY", "type": "string", "required": false, @@ -56026,7 +56216,7 @@ }, { "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", "in": "BODY", "type": "string", "required": false, diff --git a/scripts/update-endpoints/generated/ghe36-endpoints.json b/scripts/update-endpoints/generated/ghe36-endpoints.json index 71c0c456..8b17a96d 100644 --- a/scripts/update-endpoints/generated/ghe36-endpoints.json +++ b/scripts/update-endpoints/generated/ghe36-endpoints.json @@ -294,7 +294,7 @@ "url": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, - "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#create-or-update-an-environment-secret", "previews": [], "headers": [], @@ -493,7 +493,7 @@ "url": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#create-or-update-a-repository-secret", "previews": [], "headers": [], @@ -772,7 +772,7 @@ "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", "isDeprecated": false, "deprecationDate": 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\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/enterprise-server@3.6/articles/creating-a-personal-access-token-for-the-command-line).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#create-a-workflow-dispatch-event", "previews": [], "headers": [], @@ -2312,7 +2312,7 @@ "url": "/enterprises/{enterprise}/actions/permissions/workflow", "isDeprecated": false, "deprecationDate": null, - "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.6/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.", + "description": "Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise,\nas well as whether GitHub Actions can submit approving pull request reviews. For more information, see\n\"[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.6/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.\nGitHub Apps must have the `enterprise_administration:write` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#get-default-workflow-permissions-for-an-enterprise", "previews": [], "headers": [], @@ -3133,7 +3133,7 @@ "url": "/repos/{owner}/{repo}/actions/permissions/access", "isDeprecated": false, "deprecationDate": 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 internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", + "description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories.\nFor more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#get-workflow-access-level-to-a-repository", "previews": [], "headers": [], @@ -3409,6 +3409,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "name", + "description": "Filters artifacts by exact match on their name field.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -4614,7 +4627,7 @@ }, { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.6/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "QUERY", "type": "string", "required": false, @@ -4798,7 +4811,7 @@ }, { "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://docs.github.com/enterprise-server@3.6/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", "in": "QUERY", "type": "string", "required": false, @@ -6348,7 +6361,7 @@ }, { "name": "selected_repository_ids", - "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Add selected repository to an organization secret](https://docs.github.com/enterprise-server@3.6/rest/actions/secrets#add-selected-repository-to-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.6/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", "in": "BODY", "type": "integer[]", "required": true, @@ -6414,7 +6427,7 @@ "url": "/repos/{owner}/{repo}/actions/permissions/access", "isDeprecated": false, "deprecationDate": 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 internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", + "description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories.\nFor more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/enterprise-server@3.6/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#set-workflow-access-to-a-repository", "previews": [], "headers": [], @@ -6447,7 +6460,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. `none` means access is only possible from workflows in this repository.", + "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. `organization` level access allows sharing across the organization. `enterprise` level access allows sharing across the enterprise.", "in": "BODY", "type": "string", "required": true, @@ -6581,7 +6594,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -6698,14 +6711,14 @@ "url": "/notifications/threads/{thread_id}", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Gets information about a notification thread.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/activity#get-a-thread", "previews": [], "headers": [], "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -6752,7 +6765,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -7536,7 +7549,7 @@ "url": "/repos/{owner}/{repo}/notifications", "isDeprecated": false, "deprecationDate": null, - "description": "List all notifications for the current user.", + "description": "Lists all notifications for the current user in the specified repository.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-repository-notifications-for-the-authenticated-user", "previews": [], "headers": [], @@ -7905,7 +7918,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] } @@ -8045,7 +8058,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] }, @@ -8146,7 +8159,7 @@ "url": "/notifications", "isDeprecated": false, "deprecationDate": null, - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/activity#mark-notifications-as-read", "previews": [], "headers": [], @@ -8207,7 +8220,7 @@ "url": "/repos/{owner}/{repo}/notifications", "isDeprecated": false, "deprecationDate": null, - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "description": "Marks all notifications in a repository as \"read\" for the current user. If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub Enterprise Server will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List repository notifications for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/activity#list-repository-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/activity#mark-repository-notifications-as-read", "previews": [], "headers": [], @@ -8253,7 +8266,15 @@ } ], "responses": [ - { "code": 202, "description": "Response", "examples": null }, + { + "code": 202, + "description": "Response", + "examples": [ + { + "data": "{\"message\":\"Unread notifications couldn't be marked in a single request. Notifications are being marked as read in the background.\"}" + } + ] + }, { "code": 205, "description": "Reset Content", "examples": null } ], "renamed": null @@ -8266,14 +8287,14 @@ "url": "/notifications/threads/{thread_id}", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Marks a thread as \"read.\" Marking a thread as \"read\" is equivalent to clicking a notification in your notification inbox on GitHub Enterprise Server: https://github.com/notifications.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/activity#mark-a-thread-as-read", "previews": [], "headers": [], "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -8386,7 +8407,7 @@ "parameters": [ { "name": "thread_id", - "description": "The unique identifier of the pull request thread.", + "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/enterprise-server@3.6/rest/reference/activity#list-notifications-for-the-authenticated-user)).", "in": "PATH", "type": "integer", "required": true, @@ -9394,7 +9415,7 @@ "url": "/apps/{app_slug}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.6/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/enterprise-server@3.6/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/enterprise-server@3.6/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/apps/#get-an-app", "previews": [], "headers": [], @@ -9983,6 +10004,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "redelivery", + "description": "", + "in": "QUERY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -10033,7 +10067,11 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 400, "description": "Bad Request", "examples": null }, { "code": 400, "description": "Bad Request", "examples": null }, { @@ -11857,7 +11895,11 @@ } ], "responses": [ - { "code": 201, "description": "Response", "examples": null }, + { + "code": 201, + "description": "Response", + "examples": [{ "data": "null" }] + }, { "code": 403, "description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App", @@ -11925,7 +11967,13 @@ "deprecated": null } ], - "responses": [{ "code": 201, "description": "Response", "examples": null }], + "responses": [ + { + "code": 201, + "description": "Response", + "examples": [{ "data": "null" }] + } + ], "renamed": null }, { @@ -11969,7 +12017,7 @@ }, { "name": "auto_trigger_checks", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#auto_trigger_checks-object) description for details.", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.", "in": "BODY", "type": "object[]", "required": false, @@ -12174,7 +12222,7 @@ }, { "name": "output", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#output-object-1) description.", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.", "in": "BODY", "type": "object", "required": false, @@ -12226,7 +12274,7 @@ }, { "name": "output.annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://docs.github.com/enterprise-server@3.6/articles/about-status-checks#checks)\".", "in": "BODY", "type": "object[]", "required": false, @@ -12252,7 +12300,7 @@ }, { "name": "output.annotations[].start_line", - "description": "The start line of the annotation.", + "description": "The start line of the annotation. Line numbers start at 1.", "in": "BODY", "type": "integer", "required": true, @@ -12278,7 +12326,7 @@ }, { "name": "output.annotations[].start_column", - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1.", "in": "BODY", "type": "integer", "required": false, @@ -12356,7 +12404,7 @@ }, { "name": "output.images", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://docs.github.com/enterprise-server@3.6/rest/reference/checks#annotations-object-1) description for details.", + "description": "Adds images to the output displayed in the GitHub pull request UI.", "in": "BODY", "type": "object[]", "required": false, @@ -12959,7 +13007,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results before this cursor.", "in": "QUERY", "type": "string", "required": false, @@ -12972,7 +13020,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results after this cursor.", "in": "QUERY", "type": "string", "required": false, @@ -13059,11 +13107,6 @@ } ] }, - { - "code": 403, - "description": "Response if GitHub Advanced Security is not enabled for this repository", - "examples": null - }, { "code": 404, "description": "Resource not found", "examples": null }, { "code": 503, "description": "Service unavailable", "examples": null } ], @@ -13609,7 +13652,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/sarifs", "isDeprecated": false, "deprecationDate": 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.\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n - If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nThere are two places where you can upload code scanning results.\n- If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see \"[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests).\"\n- If you upload to a branch, for example `--ref refs/heads/my-branch`, then the results appear in the **Security** tab for your repository. For more information, see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64 -w0\n```\n
\nSARIF upload supports a maximum 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).\n\n\n| **SARIF data** | **Maximum values** | **Additional limits** |\n|----------------------------------|:------------------:|----------------------------------------------------------------------------------|\n| Runs per file | 15 | |\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| 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\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/reference/code-scanning#get-information-about-a-sarif-upload).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/code-scanning#upload-a-sarif-file", "previews": [], "headers": [], @@ -13999,7 +14042,7 @@ "url": "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}", "isDeprecated": false, "deprecationDate": null, - "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository\npermission to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository\npermission to use this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers) library.\n\n```\nconst sodium = require('libsodium-wrappers')\nconst secret = 'plain-text-secret' // replace with the secret you want to encrypt\nconst key = 'base64-encoded-public-key' // replace with the Base64 encoded public key\n\n//Check if libsodium is ready and then proceed.\nsodium.ready.then(() => {\n // Convert Secret & Base64 key to Uint8Array.\n let binkey = sodium.from_base64(key, sodium.base64_variants.ORIGINAL)\n let binsec = sodium.from_string(secret)\n\n //Encrypt the secret using LibSodium\n let encBytes = sodium.crypto_box_seal(binsec, binkey)\n\n // Convert encrypted Uint8Array to Base64\n let output = sodium.to_base64(encBytes, sodium.base64_variants.ORIGINAL)\n\n console.log(output)\n});\n```\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/dependabot#create-or-update-a-repository-secret", "previews": [], "headers": [], @@ -14983,7 +15026,7 @@ "url": "{origin}/setup/api/start", "isDeprecated": false, "deprecationDate": null, - "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", + "description": "When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license.\n\nNote that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#create-a-github-enterprise-server-license", "previews": [], "headers": [], @@ -15206,7 +15249,7 @@ "description": "A list of [scopes](https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "in": "BODY", "type": "string[]", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -15736,30 +15779,17 @@ "scope": "enterpriseAdmin", "id": "deleteScimGroupFromEnterprise", "method": "DELETE", - "url": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", + "url": "/scim/v2/Groups/{scim_group_id}", "isDeprecated": false, "deprecationDate": null, - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\n Deletes a SCIM group from an enterprise.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#delete-a-scim-group-from-an-enterprise", "previews": [], "headers": [], "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "scim_group_id", - "description": "Identifier generated by the GitHub SCIM endpoint.", + "description": "A unique identifier of the SCIM group.", "in": "PATH", "type": "string", "required": true, @@ -15771,7 +15801,22 @@ "deprecated": null } ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], + "responses": [ + { + "code": 204, + "description": "Group was deleted, no content", + "examples": null + }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 401, "description": "Authorization failure", "examples": null }, + { "code": 403, "description": "Permission denied", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null } + ], "renamed": null }, { @@ -15809,27 +15854,14 @@ "scope": "enterpriseAdmin", "id": "deleteUserFromEnterprise", "method": "DELETE", - "url": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", + "url": "/scim/v2/Users/{scim_user_id}", "isDeprecated": false, "deprecationDate": null, - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nPermanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#delete-a-scim-user-from-an-enterprise", "previews": [], "headers": [], "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "scim_user_id", "description": "The unique identifier of the SCIM user.", @@ -15844,7 +15876,22 @@ "deprecated": null } ], - "responses": [{ "code": 204, "description": "Response", "examples": null }], + "responses": [ + { + "code": 204, + "description": "User was deleted, no content", + "examples": null + }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 401, "description": "Authorization failure", "examples": null }, + { "code": 403, "description": "Permission denied", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null } + ], "renamed": null }, { @@ -16131,7 +16178,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Gets the current message and expiration date of the global announcement banner in your enterprise.", - "documentationUrl": "", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/announcement#get-the-global-announcement-banner", "previews": [], "headers": [], "parameters": [], @@ -16141,7 +16188,7 @@ "description": "Response", "examples": [ { - "data": "{\"announcement\":\"Very **important** announcement about _nothing_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\"}" + "data": "{\"announcement\":\"Very **important** announcement about _something_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\",\"user_dismissible\":false}" } ] } @@ -16161,7 +16208,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_commit_comments\":5000,\"total_gist_comments\":400,\"total_issue_comments\":10900,\"total_pull_request_comments\":9900}" + } + ] + } + ], "renamed": null }, { @@ -16257,7 +16314,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_gists\":500,\"private_gists\":30,\"public_gists\":470}" + } + ] + } + ], "renamed": null }, { @@ -16353,7 +16420,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_hooks\":50,\"active_hooks\":47,\"inactive_hooks\":3}" + } + ] + } + ], "renamed": null }, { @@ -16369,7 +16446,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_issues\":5000,\"open_issues\":300,\"closed_issues\":4700}" + } + ] + } + ], "renamed": null }, { @@ -16451,7 +16538,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_milestones\":90,\"open_milestones\":10,\"closed_milestones\":80}" + } + ] + } + ], "renamed": null }, { @@ -16467,7 +16564,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_orgs\":50,\"disabled_orgs\":1,\"total_teams\":70,\"total_team_members\":700}" + } + ] + } + ], "renamed": null }, { @@ -16483,7 +16590,13 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [{ "data": "{\"total_pages\":20}" }] + } + ], "renamed": null }, { @@ -16690,30 +16803,17 @@ "scope": "enterpriseAdmin", "id": "getProvisioningInformationForEnterpriseGroup", "method": "GET", - "url": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", + "url": "/scim/v2/Groups/{scim_group_id}", "isDeprecated": false, "deprecationDate": null, - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM group.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-group", "previews": [], "headers": [], "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "scim_group_id", - "description": "Identifier generated by the GitHub SCIM endpoint.", + "description": "A unique identifier of the SCIM group.", "in": "PATH", "type": "string", "required": true, @@ -16726,7 +16826,7 @@ }, { "name": "excludedAttributes", - "description": "Attributes to exclude.", + "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.", "in": "QUERY", "type": "string", "required": false, @@ -16741,13 +16841,22 @@ "responses": [ { "code": 200, - "description": "Response", + "description": "Success, a group was found", "examples": [ { - "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"id\":\"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\"externalId\":null,\"displayName\":\"octo-org\",\"members\":[{\"value\":\"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"$ref\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"display\":\"octocat@github.com\"},{\"value\":\"aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\"$ref\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\"display\":\"hubot@example.com\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2020-06-09T03:10:17.000+10:0\",\"lastModified\":\"2020-06-09T03:10:17.000+10:00\",\"location\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc\"}}" + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"id\":\"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\"externalId\":\"8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159\",\"displayName\":\"Engineering\",\"members\":[{\"value\":\"879db59-3bdf-4490-ad68-ab880a2694745\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745\",\"displayName\":\"User 1\"},{\"value\":\"0db508eb-91e2-46e4-809c-30dcbda0c685\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685\",\"displayName\":\"User 2\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e\"}}" } ] - } + }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 401, "description": "Authorization failure", "examples": null }, + { "code": 403, "description": "Permission denied", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null } ], "renamed": null }, @@ -16756,27 +16865,14 @@ "scope": "enterpriseAdmin", "id": "getProvisioningInformationForEnterpriseUser", "method": "GET", - "url": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", + "url": "/scim/v2/Users/{scim_user_id}", "isDeprecated": false, "deprecationDate": null, - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nGets information about a SCIM user.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#get-scim-provisioning-information-for-an-enterprise-user", "previews": [], "headers": [], "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "scim_user_id", "description": "The unique identifier of the SCIM user.", @@ -16794,13 +16890,22 @@ "responses": [ { "code": 200, - "description": "Response", + "description": "Success, a user was found", "examples": [ { - "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"externalId\":\"00dowz5dr9oSfDFRA0h7\",\"userName\":\"mona.octocat@okta.example.com\",\"name\":{\"givenName\":\"Mona\",\"familyName\":\"Octocat\"},\"emails\":[{\"value\":\"mona.octocat@okta.example.com\",\"type\":\"work\",\"primary\":true}],\"groups\":[{\"value\":\"468dd3fa-a1d6-11ea-9031-15a1f0d7811d\"}],\"active\":true,\"meta\":{\"resourceType\":\"User\",\"created\":\"2017-03-09T16:11:13-05:00\",\"lastModified\":\"2017-03-09T16:11:13-05:00\",\"location\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\"}}" + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"7fce0092-d52e-4f76-b727-3955bd72c939\",\"externalId\":\"E012345\",\"active\":true,\"userName\":\"E012345\",\"name\":{\"formatted\":\"Ms. Mona Lisa Octocat\",\"familyName\":\"Octocat\",\"givenName\":\"Mona\",\"middleName\":\"Lisa\"},\"displayName\":\"Mona Lisa\",\"emails\":[{\"value\":\"mlisa@example.com\",\"type\":\"work\",\"primary\":true}],\"roles\":[{\"value\":\"User\",\"primary\":false}],\"meta\":{\"resourceType\":\"User\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939\"}}" } ] - } + }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 401, "description": "Authorization failure", "examples": null }, + { "code": 403, "description": "Permission denied", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null } ], "renamed": null }, @@ -16817,7 +16922,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_pulls\":1200,\"merged_pulls\":1100,\"mergeable_pulls\":90,\"unmergeable_pulls\":10}" + } + ] + } + ], "renamed": null }, { @@ -16833,7 +16948,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_repos\":200,\"root_repos\":1,\"fork_repos\":10,\"org_repos\":150,\"total_pushes\":39000,\"total_wikis\":5}" + } + ] + } + ], "renamed": null }, { @@ -16889,7 +17014,17 @@ "previews": [], "headers": [], "parameters": [], - "responses": [{ "code": 200, "description": "Response", "examples": null }], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"total_users\":100,\"admin_users\":3,\"suspended_users\":1}" + } + ] + } + ], "renamed": null }, { @@ -17412,56 +17547,17 @@ "scope": "enterpriseAdmin", "id": "listProvisionedGroupsEnterprise", "method": "GET", - "url": "/scim/v2/enterprises/{enterprise}/Groups", + "url": "/scim/v2/Groups", "isDeprecated": false, "deprecationDate": null, - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM groups in an enterprise.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#list-provisioned-scim-groups-for-an-enterprise", "previews": [], "headers": [], "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "startIndex", - "description": "Used for pagination: the index of the first result to return.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "count", - "description": "Used for pagination: the number of results to return.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "filter", - "description": "filter results", + "description": "If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `externalId`, `id`, and `displayName`. For example, `?filter=\"externalId eq '9138790-10932-109120392-12321'\"`.", "in": "QUERY", "type": "string", "required": false, @@ -17474,7 +17570,7 @@ }, { "name": "excludedAttributes", - "description": "attributes to exclude", + "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.", "in": "QUERY", "type": "string", "required": false, @@ -17484,18 +17580,52 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "startIndex", + "description": "Used for pagination: the starting index of the first result to return when paginating through values.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "count", + "description": "Used for pagination: the number of results to return per page.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { "code": 200, - "description": "Response", + "description": "Success, either groups were found or not found", "examples": [ { - "data": "{\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:ListResponse\"],\"totalResults\":2,\"itemsPerPage\":2,\"startIndex\":1,\"Resources\":[{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"id\":\"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\"externalId\":null,\"displayName\":\"octo-org\",\"members\":[{\"value\":\"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"$ref\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"display\":\"octocat@github.com\"},{\"value\":\"aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\"$ref\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\"display\":\"hubot@example.com\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2020-06-09T03:10:17.000+10:00\",\"lastModified\":\"2020-06-09T03:10:17.000+10:00\",\"location\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc\"}},{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"id\":\"5e75bbbb-aa1a-11ea-8644-75ff655cdddd\",\"externalId\":null,\"displayName\":\"octo-docs-org\",\"members\":[{\"value\":\"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"$ref\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"display\":\"octocat@github.com\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2020-06-09T16:28:01.000+10:00\",\"lastModified\":\"2020-06-09T16:28:01.000+10:00\",\"location\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Groups/5e75bbbb-aa1a-11ea-8644-75ff655cdddd\"}}]}" + "data": "{\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:ListResponse\"],\"totalResults\":1,\"Resources\":[{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159\",\"id\":\"927fa2c08dcb4a7fae9e\",\"displayName\":\"Engineering\",\"members\":[{\"value\":\"879db59-3bdf-4490-ad68-ab880a2694745\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745\",\"displayName\":\"User 1\"},{\"value\":\"0db508eb-91e2-46e4-809c-30dcbda0c685\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685\",\"displayName\":\"User 2\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e\"}}],\"startIndex\":1,\"itemsPerPage\":20}" } ] - } + }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 401, "description": "Authorization failure", "examples": null }, + { "code": 403, "description": "Permission denied", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null } ], "renamed": null }, @@ -17504,20 +17634,20 @@ "scope": "enterpriseAdmin", "id": "listProvisionedIdentitiesEnterprise", "method": "GET", - "url": "/scim/v2/enterprises/{enterprise}/Users", + "url": "/scim/v2/Users", "isDeprecated": false, "deprecationDate": null, - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nRetrieves a paginated list of all provisioned enterprise members, including pending invitations.\n\nWhen a user with a SAML-provisioned external identity leaves (or is removed from) an enterprise, the account's metadata is immediately removed. However, the returned list of user accounts might not always match the organization or enterprise member list you see on GitHub Enterprise Server. This can happen in certain cases where an external identity associated with an organization will not match an organization member:\n - When a user with a SCIM-provisioned external identity is removed from an enterprise, the account's metadata is preserved to allow the user to re-join the organization in the future.\n - When inviting a user to join an organization, you can expect to see their external identity in the results before they accept the invitation, or if the invitation is cancelled (or never accepted).\n - When a user is invited over SCIM, an external identity is created that matches with the invitee's email address. However, this identity is only linked to a user account when the user accepts the invitation by going through SAML SSO.\n\nThe returned list of external identities can include an entry for a `null` user. These are unlinked SAML identities that are created when a user goes through the following Single Sign-On (SSO) process but does not sign in to their GitHub Enterprise Server account after completing SSO:\n\n1. The user is granted access by the IdP and is not a member of the GitHub Enterprise Server enterprise.\n\n1. The user attempts to access the GitHub Enterprise Server enterprise and initiates the SAML SSO process, and is not currently signed in to their GitHub Enterprise Server account.\n\n1. After successfully authenticating with the SAML SSO IdP, the `null` external identity entry is created and the user is prompted to sign in to their GitHub Enterprise Server account:\n - If the user signs in, their GitHub Enterprise Server account is linked to this entry.\n - If the user does not sign in (or does not create a new account when prompted), they are not added to the GitHub Enterprise Server enterprise, and the external identity `null` entry remains in place.", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nLists provisioned SCIM enterprise members.\n\nWhen a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results.\n\nYou can improve query search time by using the `excludedAttributes` query parameter with a value of `groups` to exclude groups from the response.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#list-scim-provisioned-identities-for-an-enterprise", "previews": [], "headers": [], "parameters": [ { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", + "name": "filter", + "description": "If specified, only results that match the specified filter will be returned. Multiple filters are not supported. Possible filters are `userName`, `externalId`, `id`, and `displayName`. For example, `?filter=\"externalId eq '9138790-10932-109120392-12321'\"`.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -17526,10 +17656,10 @@ "deprecated": null }, { - "name": "startIndex", - "description": "Used for pagination: the index of the first result to return.", + "name": "excludedAttributes", + "description": "Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time.", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -17539,8 +17669,8 @@ "deprecated": null }, { - "name": "count", - "description": "Used for pagination: the number of results to return.", + "name": "startIndex", + "description": "Used for pagination: the starting index of the first result to return when paginating through values.", "in": "QUERY", "type": "integer", "required": false, @@ -17552,10 +17682,10 @@ "deprecated": null }, { - "name": "filter", - "description": "filter results", + "name": "count", + "description": "Used for pagination: the number of results to return per page.", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -17568,13 +17698,21 @@ "responses": [ { "code": 200, - "description": "Response", + "description": "Success, either users were found or not found", "examples": [ { - "data": "{\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:ListResponse\"],\"totalResults\":2,\"itemsPerPage\":2,\"startIndex\":1,\"Resources\":[{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"externalId\":\"00dowz5dr9oSfDFRA0h7\",\"userName\":\"octocat@github.com\",\"name\":{\"givenName\":\"Mona\",\"familyName\":\"Octocat\"},\"emails\":[{\"value\":\"octocat@github.com\",\"primary\":true,\"type\":\"work\"}],\"groups\":[{\"value\":\"468dd3fa-a1d6-11ea-9031-15a1f0d7811d\"}],\"active\":true,\"meta\":{\"resourceType\":\"User\",\"created\":\"2020-05-30T04:02:34.000+10:00\",\"lastModified\":\"2020-05-30T04:05:04.000+10:00\",\"location\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\"}},{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5\",\"externalId\":\"sdfoiausdofiua\",\"userName\":\"hubot@example.com\",\"name\":{\"givenName\":\"hu\",\"familyName\":\"bot\"},\"emails\":[{\"value\":\"hubot@example.com\",\"type\":\"work\",\"primary\":true}],\"groups\":[],\"active\":true,\"meta\":{\"resourceType\":\"User\",\"created\":\"2020-06-05T08:29:40.000+10:00\",\"lastModified\":\"2020-06-05T08:30:19.000+10:00\",\"location\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/e18b8c34-a6b2-11ea-9d70-54abbd1c8fd5\"}}]}" + "data": "{\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:ListResponse\"],\"totalResults\":1,\"Resources\":[{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"externalId\":\"E012345\",\"id\":\"7fce0092-d52e-4f76-b727-3955bd72c939\",\"active\":true,\"userName\":\"E012345\",\"name\":{\"formatted\":\"Ms. Mona Lisa Octocat\",\"familyName\":\"Octocat\",\"givenName\":\"Mona\",\"middleName\":\"Lisa\"},\"displayName\":\"Mona Lisa\",\"emails\":[{\"value\":\"mlisa@example.com\",\"type\":\"work\",\"primary\":true}],\"roles\":[{\"value\":\"User\",\"primary\":false}]}],\"startIndex\":1,\"itemsPerPage\":20}" } ] - } + }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 401, "description": "Authorization failure", "examples": null }, + { "code": 403, "description": "Permission denied", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null } ], "renamed": null }, @@ -17797,23 +17935,23 @@ "renamed": null }, { - "name": "Provision a SCIM enterprise group and invite users", + "name": "Provision a SCIM enterprise group", "scope": "enterpriseAdmin", - "id": "provisionAndInviteEnterpriseGroup", + "id": "provisionEnterpriseGroup", "method": "POST", - "url": "/scim/v2/enterprises/{enterprise}/Groups", + "url": "/scim/v2/Groups", "isDeprecated": false, "deprecationDate": null, - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nProvision an enterprise group, and invite users to the group. This sends invitation emails to the email address of the invited users to join the GitHub organization that the SCIM group corresponds to.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group-and-invite-users", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates a SCIM group for an enterprise.\n\nIf members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-group", "previews": [], "headers": [], "parameters": [ { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", + "name": "schemas", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "in": "BODY", + "type": "string[]", "required": true, "enum": null, "allowNull": false, @@ -17823,10 +17961,10 @@ "deprecated": null }, { - "name": "schemas", - "description": "The SCIM schema URIs.", + "name": "externalId", + "description": "A unique identifier for the resource as defined by the provisioning client.", "in": "BODY", - "type": "string[]", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -17837,7 +17975,7 @@ }, { "name": "displayName", - "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to.", + "description": "A human-readable name for a security group.", "in": "BODY", "type": "string", "required": true, @@ -17850,10 +17988,10 @@ }, { "name": "members", - "description": "", + "description": "The group members.", "in": "BODY", "type": "object[]", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -17863,7 +18001,20 @@ }, { "name": "members[].value", - "description": "The SCIM user ID for a user.", + "description": "The local unique identifier for the member", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "members[].displayName", + "description": "The display name associated with the member", "in": "BODY", "type": "string", "required": true, @@ -17878,33 +18029,59 @@ "responses": [ { "code": 201, - "description": "Response", + "description": "Group has been created", "examples": [ { - "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"id\":\"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\"externalId\":null,\"displayName\":\"octo-org\",\"members\":[{\"value\":\"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"$ref\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"display\":\"octocat@github.com\"},{\"value\":\"aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\"$ref\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\"display\":\"hubot@example.com\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2020-06-09T03:10:17.000+10:0\",\"lastModified\":\"2020-06-09T03:10:17.000+10:00\",\"location\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc\"}}" + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"id\":\"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\"externalId\":\"8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159\",\"displayName\":\"Engineering\",\"members\":[{\"value\":\"879db59-3bdf-4490-ad68-ab880a2694745\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745\",\"displayName\":\"User 1\"},{\"value\":\"0db508eb-91e2-46e4-809c-30dcbda0c685\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685\",\"displayName\":\"User 2\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e\"}}" } ] - } + }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 401, "description": "Authorization failure", "examples": null }, + { "code": 403, "description": "Permission denied", "examples": null }, + { + "code": 409, + "description": "Duplicate record detected", + "examples": null + }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null } ], "renamed": null }, { - "name": "Provision and invite a SCIM enterprise user", + "name": "Provision a SCIM enterprise user", "scope": "enterpriseAdmin", - "id": "provisionAndInviteEnterpriseUser", + "id": "provisionEnterpriseUser", "method": "POST", - "url": "/scim/v2/enterprises/{enterprise}/Users", + "url": "/scim/v2/Users", "isDeprecated": false, "deprecationDate": null, - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nProvision enterprise membership for a user, and send organization invitation emails to the email address.\n\nYou can optionally include the groups a user will be invited to join. If you do not provide a list of `groups`, the user is provisioned for the enterprise, but no organization invitation emails will be sent.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-and-invite-a-scim-enterprise-user", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nCreates an external identity for a new SCIM enterprise user.\n\nSCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`.\n\nWhen converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#provision-a-scim-enterprise-user", "previews": [], "headers": [], "parameters": [ { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", + "name": "schemas", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "in": "BODY", + "type": "string[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "externalId", + "description": "A unique identifier for the resource as defined by the provisioning client.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -17915,10 +18092,10 @@ "deprecated": null }, { - "name": "schemas", - "description": "The SCIM schema URIs.", + "name": "active", + "description": "Whether the user active in the IdP.", "in": "BODY", - "type": "string[]", + "type": "boolean", "required": true, "enum": null, "allowNull": false, @@ -17945,6 +18122,32 @@ "description": "", "in": "BODY", "type": "object", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name.formatted", + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name.familyName", + "description": "The family name of the user.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -17955,7 +18158,7 @@ }, { "name": "name.givenName", - "description": "The first name of the user.", + "description": "The given name of the user.", "in": "BODY", "type": "string", "required": true, @@ -17967,8 +18170,21 @@ "deprecated": null }, { - "name": "name.familyName", - "description": "The last name of the user.", + "name": "name.middleName", + "description": "The middle name(s) of the user.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "displayName", + "description": "A human-readable name for the user.", "in": "BODY", "type": "string", "required": true, @@ -17981,7 +18197,7 @@ }, { "name": "emails", - "description": "List of user emails.", + "description": "The emails for the user.", "in": "BODY", "type": "object[]", "required": true, @@ -18032,8 +18248,8 @@ "deprecated": null }, { - "name": "groups", - "description": "List of SCIM group IDs the user is a member of.", + "name": "roles", + "description": "The roles assigned to the user.", "in": "BODY", "type": "object[]", "required": false, @@ -18045,7 +18261,7 @@ "deprecated": null }, { - "name": "groups[].value", + "name": "roles[].display", "description": "", "in": "BODY", "type": "string", @@ -18056,18 +18272,88 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "roles[].type", + "description": "", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "roles[].value", + "description": "The role value representing a user role in GitHub.", + "in": "BODY", + "type": "string", + "required": true, + "enum": [ + "User", + "user", + "27d9891d-2c17-4f45-a262-781a0e55c80a", + "Restricted User", + "restricted_user", + "1ebc4a02-e56c-43a6-92a5-02ee09b90824", + "Enterprise Owner", + "enterprise_owner", + "981df190-8801-4618-a08a-d91f6206c954", + "ba4987ab-a1c3-412a-b58c-360fc407cb10", + "Billing Manager", + "billing_manager", + "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", + "e6be2762-e4ad-4108-b72d-1bbe884a0f91" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "roles[].primary", + "description": "Is the role a primary role for the user.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { "code": 201, - "description": "Response", + "description": "User has been created", "examples": [ { - "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"externalId\":\"00dowz5dr9oSfDFRA0h7\",\"userName\":\"mona.octocat@okta.example.com\",\"name\":{\"givenName\":\"Mona\",\"familyName\":\"Octocat\"},\"emails\":[{\"value\":\"mona.octocat@okta.example.com\",\"type\":\"work\",\"primary\":true}],\"groups\":[{\"value\":\"468dd3fa-a1d6-11ea-9031-15a1f0d7811d\"}],\"active\":true,\"meta\":{\"resourceType\":\"User\",\"created\":\"2017-03-09T16:11:13-05:00\",\"lastModified\":\"2017-03-09T16:11:13-05:00\",\"location\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\"}}" + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"7fce0092-d52e-4f76-b727-3955bd72c939\",\"externalId\":\"E012345\",\"active\":true,\"userName\":\"E012345\",\"name\":{\"formatted\":\"Ms. Mona Lisa Octocat\",\"familyName\":\"Octocat\",\"givenName\":\"Mona\",\"middleName\":\"Lisa\"},\"displayName\":\"Mona Lisa\",\"emails\":[{\"value\":\"mlisa@example.com\",\"type\":\"work\",\"primary\":true}],\"roles\":[{\"value\":\"User\",\"primary\":false}],\"meta\":{\"resourceType\":\"User\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939\"}}" + }, + { + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"7fce0092-d52e-4f76-b727-3955bd72c939\",\"externalId\":\"E012345\",\"active\":true,\"userName\":\"E012345\",\"name\":{\"formatted\":\"Ms. Mona Lisa Octocat\",\"familyName\":\"Octocat\",\"givenName\":\"Mona\",\"middleName\":\"Lisa\"},\"displayName\":\"Mona Lisa\",\"emails\":[{\"value\":\"mlisa@example.com\",\"type\":\"work\",\"primary\":true}],\"roles\":[{\"value\":\"User\",\"primary\":false}],\"meta\":{\"resourceType\":\"User\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939\"}}" } ] - } + }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 401, "description": "Authorization failure", "examples": null }, + { "code": 403, "description": "Permission denied", "examples": null }, + { + "code": 409, + "description": "Duplicate record detected", + "examples": null + }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null } ], "renamed": null }, @@ -18139,7 +18425,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Removes the global announcement banner in your enterprise.", - "documentationUrl": "", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/announcement#remove-the-global-announcement-banner", "previews": [], "headers": [], "parameters": [], @@ -18455,7 +18741,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Sets the message and expiration time for the global announcement banner in your enterprise.", - "documentationUrl": "", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/enterprise-admin/announcement#set-the-global-announcement-banner", "previews": [], "headers": [], "parameters": [ @@ -18466,7 +18752,7 @@ "type": "string", "required": true, "enum": null, - "allowNull": false, + "allowNull": true, "mapToData": null, "validation": null, "alias": null, @@ -18492,7 +18778,7 @@ "description": "Response", "examples": [ { - "data": "{\"announcement\":\"Very **important** announcement about _nothing_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\"}" + "data": "{\"announcement\":\"Very **important** announcement about _something_.\",\"expires_at\":\"2021-01-01T00:00:00.000+00:00\",\"user_dismissible\":false}" } ] } @@ -18632,17 +18918,17 @@ "scope": "enterpriseAdmin", "id": "setInformationForProvisionedEnterpriseGroup", "method": "PUT", - "url": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", + "url": "/scim/v2/Groups/{scim_group_id}", "isDeprecated": false, "deprecationDate": null, - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nReplaces an existing provisioned group’s information. You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned group’s information.\n\nYou must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-group", "previews": [], "headers": [], "parameters": [ { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "name": "scim_group_id", + "description": "A unique identifier of the SCIM group.", "in": "PATH", "type": "string", "required": true, @@ -18654,10 +18940,10 @@ "deprecated": null }, { - "name": "scim_group_id", - "description": "Identifier generated by the GitHub SCIM endpoint.", - "in": "PATH", - "type": "string", + "name": "schemas", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "in": "BODY", + "type": "string[]", "required": true, "enum": null, "allowNull": false, @@ -18667,10 +18953,10 @@ "deprecated": null }, { - "name": "schemas", - "description": "The SCIM schema URIs.", + "name": "externalId", + "description": "A unique identifier for the resource as defined by the provisioning client.", "in": "BODY", - "type": "string[]", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -18681,7 +18967,7 @@ }, { "name": "displayName", - "description": "The name of the SCIM group. This must match the GitHub organization that the group maps to.", + "description": "A human-readable name for a security group.", "in": "BODY", "type": "string", "required": true, @@ -18694,10 +18980,10 @@ }, { "name": "members", - "description": "", + "description": "The group members.", "in": "BODY", "type": "object[]", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -18707,7 +18993,20 @@ }, { "name": "members[].value", - "description": "The SCIM user ID for a user.", + "description": "The local unique identifier for the member", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "members[].displayName", + "description": "The display name associated with the member", "in": "BODY", "type": "string", "required": true, @@ -18722,13 +19021,30 @@ "responses": [ { "code": 200, - "description": "Response", + "description": "Group was updated", "examples": [ { - "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"id\":\"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\"externalId\":null,\"displayName\":\"octo-org\",\"members\":[{\"value\":\"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"$ref\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"display\":\"octocat@github.com\"},{\"value\":\"aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\"$ref\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/aaaa8c34-a6b2-11ea-9d70-bbbbbd1c8fd5\",\"display\":\"hubot@example.com\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2020-06-09T03:10:17.000+10:0\",\"lastModified\":\"2020-06-09T03:10:17.000+10:00\",\"location\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc\"}}" + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"id\":\"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\"externalId\":\"8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159\",\"displayName\":\"Engineering\",\"members\":[{\"value\":\"879db59-3bdf-4490-ad68-ab880a2694745\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745\",\"displayName\":\"User 1\"},{\"value\":\"0db508eb-91e2-46e4-809c-30dcbda0c685\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685\",\"displayName\":\"User 2\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e\"}}" + }, + { + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"id\":\"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\"externalId\":\"8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159\",\"displayName\":\"Engineering\",\"members\":[{\"value\":\"879db59-3bdf-4490-ad68-ab880a2694745\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745\",\"displayName\":\"User 1\"},{\"value\":\"0db508eb-91e2-46e4-809c-30dcbda0c685\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685\",\"displayName\":\"User 2\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e\"}}" } ] - } + }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 401, "description": "Authorization failure", "examples": null }, + { "code": 403, "description": "Permission denied", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 409, + "description": "Duplicate record detected", + "examples": null + }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null } ], "renamed": null }, @@ -18737,17 +19053,17 @@ "scope": "enterpriseAdmin", "id": "setInformationForProvisionedEnterpriseUser", "method": "PUT", - "url": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", + "url": "/scim/v2/Users/{scim_user_id}", "isDeprecated": false, "deprecationDate": null, - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nReplaces an existing provisioned user's information. You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-an-enterprise-scim-user) endpoint instead.\n\nYou must at least provide the required values for the user: `userName`, `name`, and `emails`.\n\n**Warning:** Setting `active: false` removes the user from the enterprise, deletes the external identity, and deletes the associated `{scim_user_id}`.", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nReplaces an existing provisioned user's information.\n\nYou must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead.\n\n**Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#set-scim-information-for-a-provisioned-enterprise-user", "previews": [], "headers": [], "parameters": [ { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "name": "scim_user_id", + "description": "The unique identifier of the SCIM user.", "in": "PATH", "type": "string", "required": true, @@ -18759,9 +19075,22 @@ "deprecated": null }, { - "name": "scim_user_id", - "description": "The unique identifier of the SCIM user.", - "in": "PATH", + "name": "schemas", + "description": "The URIs that are used to indicate the namespaces of the SCIM schemas.", + "in": "BODY", + "type": "string[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "externalId", + "description": "A unique identifier for the resource as defined by the provisioning client.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -18772,10 +19101,10 @@ "deprecated": null }, { - "name": "schemas", - "description": "The SCIM schema URIs.", + "name": "active", + "description": "Whether the user active in the IdP.", "in": "BODY", - "type": "string[]", + "type": "boolean", "required": true, "enum": null, "allowNull": false, @@ -18802,6 +19131,32 @@ "description": "", "in": "BODY", "type": "object", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name.formatted", + "description": "The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name.familyName", + "description": "The family name of the user.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -18812,7 +19167,7 @@ }, { "name": "name.givenName", - "description": "The first name of the user.", + "description": "The given name of the user.", "in": "BODY", "type": "string", "required": true, @@ -18824,8 +19179,21 @@ "deprecated": null }, { - "name": "name.familyName", - "description": "The last name of the user.", + "name": "name.middleName", + "description": "The middle name(s) of the user.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "displayName", + "description": "A human-readable name for the user.", "in": "BODY", "type": "string", "required": true, @@ -18838,7 +19206,7 @@ }, { "name": "emails", - "description": "List of user emails.", + "description": "The emails for the user.", "in": "BODY", "type": "object[]", "required": true, @@ -18889,8 +19257,8 @@ "deprecated": null }, { - "name": "groups", - "description": "List of SCIM group IDs the user is a member of.", + "name": "roles", + "description": "The roles assigned to the user.", "in": "BODY", "type": "object[]", "required": false, @@ -18902,7 +19270,7 @@ "deprecated": null }, { - "name": "groups[].value", + "name": "roles[].display", "description": "", "in": "BODY", "type": "string", @@ -18913,18 +19281,86 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "roles[].type", + "description": "", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "roles[].value", + "description": "The role value representing a user role in GitHub.", + "in": "BODY", + "type": "string", + "required": true, + "enum": [ + "User", + "user", + "27d9891d-2c17-4f45-a262-781a0e55c80a", + "Restricted User", + "restricted_user", + "1ebc4a02-e56c-43a6-92a5-02ee09b90824", + "Enterprise Owner", + "enterprise_owner", + "981df190-8801-4618-a08a-d91f6206c954", + "ba4987ab-a1c3-412a-b58c-360fc407cb10", + "Billing Manager", + "billing_manager", + "0e338b8c-cc7f-498a-928d-ea3470d7e7e3", + "e6be2762-e4ad-4108-b72d-1bbe884a0f91" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "roles[].primary", + "description": "Is the role a primary role for the user.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { "code": 200, - "description": "Response", + "description": "User was updated", "examples": [ { - "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"externalId\":\"00dowz5dr9oSfDFRA0h7\",\"userName\":\"mona.octocat@okta.example.com\",\"name\":{\"givenName\":\"Mona\",\"familyName\":\"Octocat\"},\"emails\":[{\"value\":\"mona.octocat@okta.example.com\",\"type\":\"work\",\"primary\":true}],\"groups\":[{\"value\":\"468dd3fa-a1d6-11ea-9031-15a1f0d7811d\"}],\"active\":true,\"meta\":{\"resourceType\":\"User\",\"created\":\"2017-03-09T16:11:13-05:00\",\"lastModified\":\"2017-03-09T16:11:13-05:00\",\"location\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\"}}" + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"7fce0092-d52e-4f76-b727-3955bd72c939\",\"externalId\":\"E012345\",\"active\":true,\"userName\":\"E012345\",\"name\":{\"formatted\":\"Ms. Mona Lisa Octocat\",\"familyName\":\"Octocat\",\"givenName\":\"Mona\",\"middleName\":\"Lisa\"},\"displayName\":\"Mona Lisa\",\"emails\":[{\"value\":\"mlisa@example.com\",\"type\":\"work\",\"primary\":true}],\"roles\":[{\"value\":\"User\",\"primary\":false}],\"meta\":{\"resourceType\":\"User\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939\"}}" } ] - } + }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 401, "description": "Authorization failure", "examples": null }, + { "code": 403, "description": "Permission denied", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 409, + "description": "Duplicate record detected", + "examples": null + }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null } ], "renamed": null }, @@ -19256,30 +19692,17 @@ "scope": "enterpriseAdmin", "id": "updateAttributeForEnterpriseGroup", "method": "PATCH", - "url": "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", + "url": "/scim/v2/Groups/{scim_group_id}", "isDeprecated": false, "deprecationDate": null, - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nAllows you to change a provisioned group’s individual attributes. To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned group’s individual attributes.\n\nTo change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships.\n\nGroup memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-group", "previews": [], "headers": [], "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "scim_group_id", - "description": "Identifier generated by the GitHub SCIM endpoint.", + "description": "A unique identifier of the SCIM group.", "in": "PATH", "type": "string", "required": true, @@ -19291,10 +19714,10 @@ "deprecated": null }, { - "name": "schemas", - "description": "The SCIM schema URIs.", + "name": "Operations", + "description": "patch operations list", "in": "BODY", - "type": "string[]", + "type": "object[]", "required": true, "enum": null, "allowNull": false, @@ -19304,12 +19727,12 @@ "deprecated": null }, { - "name": "Operations", - "description": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "name": "Operations[].op", + "description": "", "in": "BODY", - "type": "object[]", + "type": "string", "required": true, - "enum": null, + "enum": ["add", "replace", "remove"], "allowNull": false, "mapToData": null, "validation": null, @@ -19317,12 +19740,12 @@ "deprecated": null }, { - "name": "Operations[].op", + "name": "Operations[].path", "description": "", "in": "BODY", "type": "string", - "required": true, - "enum": ["add", "Add", "remove", "Remove", "replace", "Replace"], + "required": false, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -19330,8 +19753,8 @@ "deprecated": null }, { - "name": "Operations[].path", - "description": "", + "name": "Operations[].value", + "description": "Corresponding 'value' of that field specified by 'path'", "in": "BODY", "type": "string", "required": false, @@ -19343,11 +19766,11 @@ "deprecated": null }, { - "name": "Operations[].value", - "description": "Can be any value - string, number, array or object.", + "name": "schemas", + "description": "", "in": "BODY", - "type": null, - "required": false, + "type": "string[]", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -19359,13 +19782,31 @@ "responses": [ { "code": 200, - "description": "Response", + "description": "Success, group was updated", "examples": [ { - "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"id\":\"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\"externalId\":null,\"displayName\":\"octo-org\",\"members\":[{\"value\":\"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"$ref\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"display\":\"octocat@github.com\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2020-06-09T03:10:17.000+10:00\",\"lastModified\":\"2020-06-09T03:10:17.000+10:00\",\"location\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Groups/abcd27f8-a9aa-11ea-8221-f59b2be9cccc\"}}" + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"id\":\"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\"externalId\":\"8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159\",\"displayName\":\"Engineering\",\"members\":[{\"value\":\"879db59-3bdf-4490-ad68-ab880a2694745\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745\",\"displayName\":\"User 1\"},{\"value\":\"0db508eb-91e2-46e4-809c-30dcbda0c685\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685\",\"displayName\":\"User 2\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e\"}}" + }, + { + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"id\":\"abcd27f8-a9aa-11ea-8221-f59b2be9cccc\",\"externalId\":\"8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159\",\"displayName\":\"Engineering\",\"members\":[{\"value\":\"879db59-3bdf-4490-ad68-ab880a2694745\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745\",\"displayName\":\"User 1\"},{\"value\":\"0db508eb-91e2-46e4-809c-30dcbda0c685\",\"$+ref\":\"https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685\",\"displayName\":\"User 2\"}],\"meta\":{\"resourceType\":\"Group\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e\"}}" } ] - } + }, + { "code": 204, "description": "Response", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 401, "description": "Authorization failure", "examples": null }, + { "code": 403, "description": "Permission denied", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 409, + "description": "Duplicate record detected", + "examples": null + }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null } ], "renamed": null }, @@ -19374,17 +19815,17 @@ "scope": "enterpriseAdmin", "id": "updateAttributeForEnterpriseUser", "method": "PATCH", - "url": "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", + "url": "/scim/v2/Users/{scim_user_id}", "isDeprecated": false, "deprecationDate": null, - "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in beta and are subject to change.\n\nAllows you to change a provisioned user's individual attributes. To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n**Warning:** If you set `active:false` using the `replace` operation (as shown in the JSON example below), it removes the user from the enterprise, deletes the external identity, and deletes the associated `:scim_user_id`.\n\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```", + "description": "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n**Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#update-an-attribute-for-a-scim-enterprise-user", "previews": [], "headers": [], "parameters": [ { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "name": "scim_user_id", + "description": "The unique identifier of the SCIM user.", "in": "PATH", "type": "string", "required": true, @@ -19396,10 +19837,10 @@ "deprecated": null }, { - "name": "scim_user_id", - "description": "The unique identifier of the SCIM user.", - "in": "PATH", - "type": "string", + "name": "Operations", + "description": "patch operations list", + "in": "BODY", + "type": "object[]", "required": true, "enum": null, "allowNull": false, @@ -19409,11 +19850,24 @@ "deprecated": null }, { - "name": "schemas", - "description": "The SCIM schema URIs.", + "name": "Operations[].op", + "description": "", "in": "BODY", - "type": "string[]", + "type": "string", "required": true, + "enum": ["add", "replace", "remove"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "Operations[].path", + "description": "", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -19422,10 +19876,23 @@ "deprecated": null }, { - "name": "Operations", - "description": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "name": "Operations[].value", + "description": "Corresponding 'value' of that field specified by 'path'", "in": "BODY", - "type": "object[]", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "schemas", + "description": "", + "in": "BODY", + "type": "string[]", "required": true, "enum": null, "allowNull": false, @@ -19438,13 +19905,33 @@ "responses": [ { "code": 200, - "description": "Response", + "description": "Success, user was updated", "examples": [ { - "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\",\"externalId\":\"00dowz5dr9oSfDFRA0h7\",\"userName\":\"mona.octocat@okta.example.com\",\"name\":{\"givenName\":\"Monalisa\",\"familyName\":\"Octocat\"},\"emails\":[{\"value\":\"mona.octocat@okta.example.com\",\"type\":\"work\",\"primary\":true},{\"value\":\"monalisa@octocat.github.com\",\"type\":\"home\"}],\"groups\":[{\"value\":\"468dd3fa-a1d6-11ea-9031-15a1f0d7811d\"}],\"active\":true,\"meta\":{\"resourceType\":\"User\",\"created\":\"2017-03-09T16:11:13-05:00\",\"lastModified\":\"2017-03-09T16:11:13-05:00\",\"location\":\"https://api.github.com/scim/v2/enterprises/octo-corp/Users/92b58aaa-a1d6-11ea-8227-b9ce9e023ccc\"}}" + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"7fce0092-d52e-4f76-b727-3955bd72c939\",\"externalId\":\"E012345\",\"active\":true,\"userName\":\"E012345\",\"name\":{\"formatted\":\"Ms. Mona Lisa Octocat\",\"familyName\":\"Octocat\",\"givenName\":\"Mona\",\"middleName\":\"Lisa\"},\"displayName\":\"Mona Lisa\",\"emails\":[{\"value\":\"mlisa@example.com\",\"type\":\"work\",\"primary\":true}],\"roles\":[{\"value\":\"User\",\"primary\":false}],\"meta\":{\"resourceType\":\"User\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939\"}}" + }, + { + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"7fce0092-d52e-4f76-b727-3955bd72c939\",\"externalId\":\"E012345\",\"active\":true,\"userName\":\"E012345\",\"name\":{\"formatted\":\"Ms. Mona Lisa Octocat\",\"familyName\":\"Octocat\",\"givenName\":\"Mona\",\"middleName\":\"Lisa\"},\"displayName\":\"Mona Lisa\",\"emails\":[{\"value\":\"mlisa@example.com\",\"type\":\"work\",\"primary\":true}],\"roles\":[{\"value\":\"User\",\"primary\":false}],\"meta\":{\"resourceType\":\"User\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939\"}}" + }, + { + "data": "{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"id\":\"7fce0092-d52e-4f76-b727-3955bd72c939\",\"externalId\":\"E012345\",\"active\":true,\"userName\":\"E012345\",\"name\":{\"formatted\":\"Ms. Mona Lisa Octocat\",\"familyName\":\"Octocat\",\"givenName\":\"Mona\",\"middleName\":\"Lisa\"},\"displayName\":\"Mona Lisa\",\"emails\":[{\"value\":\"mlisa@example.com\",\"type\":\"work\",\"primary\":true}],\"roles\":[{\"value\":\"User\",\"primary\":false}],\"meta\":{\"resourceType\":\"User\",\"created\":\"2012-03-27T19:59:26.000Z\",\"lastModified\":\"2018-03-27T19:59:26.000Z\",\"location\":\"https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939\"}}" } ] - } + }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 400, "description": "Bad request", "examples": null }, + { "code": 401, "description": "Authorization failure", "examples": null }, + { "code": 403, "description": "Permission denied", "examples": null }, + { "code": 404, "description": "Resource not found", "examples": null }, + { + "code": 409, + "description": "Duplicate record detected", + "examples": null + }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 429, "description": "Too many requests", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null }, + { "code": 500, "description": "Internal server error", "examples": null } ], "renamed": null }, @@ -20176,7 +20663,7 @@ "url": "{origin}/setup/api/upgrade", "isDeprecated": false, "deprecationDate": null, - "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode).", + "description": "This API upgrades your license and also triggers the configuration process.\n\n**Note:** The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F).", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/enterprise-admin#upgrade-a-license", "previews": [], "headers": [], @@ -20339,7 +20826,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" } ] }, @@ -20574,7 +21061,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" } ] }, @@ -20686,7 +21173,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" } ] }, @@ -21283,7 +21770,7 @@ "url": "/gists/{gist_id}", "isDeprecated": false, "deprecationDate": null, - "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", + "description": "Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/gists/#update-a-gist", "previews": [], "headers": [], @@ -21303,7 +21790,7 @@ }, { "name": "description", - "description": "Description of the gist", + "description": "The description of the gist.", "in": "BODY", "type": "string", "required": false, @@ -21316,7 +21803,7 @@ }, { "name": "files", - "description": "Names of files to be updated", + "description": "The gist files to be updated, renamed, or deleted. Each `key` must match the current filename\n(including extension) of the targeted gist file. For example: `hello.py`.\n\nTo delete a file, set the whole file to null. For example: `hello.py : null`.", "in": "BODY", "type": "object", "required": false, @@ -21342,7 +21829,7 @@ }, { "name": "files.*.content", - "description": "The new content of the file", + "description": "The new content of the file.", "in": "BODY", "type": "string", "required": false, @@ -21355,7 +21842,7 @@ }, { "name": "files.*.filename", - "description": "The new filename for the file", + "description": "The new filename for the file.", "in": "BODY", "type": "string", "required": false, @@ -21373,7 +21860,13 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"}" + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"README.md\":{\"filename\":\"README.md\",\"type\":\"text/markdown\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md\",\"size\":23,\"truncated\":false,\"content\":\"Hello world from GitHub\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"An updated gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":2,\"additions\":1,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" + }, + { + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":null,\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"A gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"9cc352a89178a6d4\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":1,\"additions\":0,\"deletions\":1},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" + }, + { + "data": "{\"url\":\"https://api.github.com/gists/2decf6c462d9b4418f2\",\"forks_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/forks\",\"commits_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/commits\",\"id\":\"2decf6c462d9b4418f2\",\"node_id\":\"G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy\",\"git_pull_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"git_push_url\":\"https://gist.github.com/2decf6c462d9b4418f2.git\",\"html_url\":\"https://gist.github.com/2decf6c462d9b4418f2\",\"files\":{\"goodbye.py\":{\"filename\":\"goodbye.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/monalisa/8481a81af6b7a2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/goodbye.py\",\"size\":4,\"truncated\":false,\"content\":\"# Hello world\"}},\"public\":true,\"created_at\":\"2022-09-20T12:11:58Z\",\"updated_at\":\"2022-09-21T10:28:06Z\",\"description\":\"A gist description.\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/2decf6c462d9b4418f2/comments\",\"owner\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgDOBhHyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"forks\":[],\"history\":[{\"user\":{\"login\":\"monalisa\",\"id\":104456405,\"node_id\":\"U_kgyLQ\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/104456405?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/monalisa\",\"html_url\":\"https://github.com/monalisa\",\"followers_url\":\"https://api.github.com/users/monalisa/followers\",\"following_url\":\"https://api.github.com/users/monalisa/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/monalisa/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/monalisa/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/monalisa/subscriptions\",\"organizations_url\":\"https://api.github.com/users/monalisa/orgs\",\"repos_url\":\"https://api.github.com/users/monalisa/repos\",\"events_url\":\"https://api.github.com/users/monalisa/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/monalisa/received_events\",\"type\":\"User\",\"site_admin\":true},\"version\":\"468aac8caed5f0c3b859b8286968\",\"committed_at\":\"2022-09-21T10:28:06Z\",\"change_status\":{\"total\":0,\"additions\":0,\"deletions\":0},\"url\":\"https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968\"}],\"truncated\":false}" } ] }, @@ -23067,6 +23560,86 @@ ], "renamed": null }, + { + "name": "Check if a user can be assigned to a issue", + "scope": "issues", + "id": "checkUserCanBeAssignedToIssue", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}", + "isDeprecated": false, + "deprecationDate": null, + "description": "Checks if a user has permission to be assigned to a specific issue.\n\nIf the `assignee` can be assigned to this issue, a `204` status code with no content is returned.\n\nOtherwise a `404` status code is returned.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/issues#check-if-a-user-can-be-assigned-to-a-issue", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "The name of the repository. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "issue_number", + "description": "The number that identifies the issue.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "assignee", + "description": "", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 204, + "description": "Response if `assignee` can be assigned to `issue_number`", + "examples": null + }, + { + "code": 404, + "description": "Response if `assignee` can not be assigned to `issue_number`", + "examples": null + } + ], + "renamed": null + }, { "name": "Create an issue", "scope": "issues", @@ -23075,7 +23648,7 @@ "url": "/repos/{owner}/{repo}/issues", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/issues#create-an-issue", "previews": [], "headers": [], @@ -23682,7 +24255,7 @@ "url": "/repos/{owner}/{repo}/issues/{issue_number}", "isDeprecated": false, "deprecationDate": null, - "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.", + "description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/issues#get-an-issue", "previews": [], "headers": [], @@ -24022,7 +24595,7 @@ "url": "/issues", "isDeprecated": false, "deprecationDate": 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 v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/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\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/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/issues#list-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], @@ -24219,7 +24792,7 @@ "url": "/repos/{owner}/{repo}/assignees", "isDeprecated": false, "deprecationDate": null, - "description": "Lists the [available assignees](https://docs.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "description": "Lists the [available assignees](https://docs.github.com/enterprise-server@3.6/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/issues#list-assignees", "previews": [], "headers": [], @@ -24801,7 +25374,7 @@ "url": "/user/issues", "isDeprecated": false, "deprecationDate": null, - "description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/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/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/issues#list-user-account-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], @@ -24941,7 +25514,7 @@ "url": "/orgs/{org}/issues", "isDeprecated": false, "deprecationDate": null, - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/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/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/issues#list-organization-issues-assigned-to-the-authenticated-user", "previews": [], "headers": [], @@ -25093,7 +25666,7 @@ "url": "/repos/{owner}/{repo}/issues", "isDeprecated": false, "deprecationDate": null, - "description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/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/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/issues#list-repository-issues", "previews": [], "headers": [], @@ -25728,7 +26301,7 @@ }, { "name": "lock_reason", - "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", + "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`", "in": "BODY", "type": "string", "required": false, @@ -26144,7 +26717,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Issue owners and users with push access can edit an issue.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/issues/#update-an-issue", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/issues#update-an-issue", "previews": [], "headers": [], "parameters": [ @@ -26839,7 +27412,11 @@ } ], "responses": [ - { "code": 200, "description": "Response", "examples": null }, + { + "code": 200, + "description": "Response", + "examples": [{ "data": "\"

Hello world

\"" }] + }, { "code": 304, "description": "Not modified", "examples": null } ], "renamed": null @@ -26874,7 +27451,11 @@ } ], "responses": [ - { "code": 200, "description": "Response", "examples": null }, + { + "code": 200, + "description": "Response", + "examples": [{ "data": "\"

Hello world

\"" }] + }, { "code": 304, "description": "Not modified", "examples": null } ], "renamed": null @@ -26955,7 +27536,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Get a random sentence from the Zen of GitHub", - "documentationUrl": "", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/meta#get-the-zen-of-github", "previews": [], "headers": [], "parameters": [], @@ -27298,7 +27879,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] }, @@ -27365,7 +27946,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] }, @@ -28011,7 +28592,7 @@ }, { "name": "events", - "description": "Determines what [events](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads) the hook is triggered for.", + "description": "Determines what [events](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads) the hook is triggered for. Set to `[\"*\"]` to receive all possible events.", "in": "BODY", "type": "string[]", "required": false, @@ -28109,7 +28690,7 @@ "url": "/orgs/{org}", "isDeprecated": false, "deprecationDate": 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 Enterprise Server plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@3.6/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"", + "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.6/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 Enterprise Server plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/enterprise-server@3.6/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub Enterprise Server plan information' below.\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#get-an-organization", "previews": [], "headers": [], @@ -28547,7 +29128,7 @@ "url": "/organizations/{organization_id}/custom_roles", "isDeprecated": false, "deprecationDate": null, - "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.6/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".", + "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organization and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[About custom repository roles](https://docs.github.com/enterprise-server@3.6/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#list-custom-repository-roles-in-an-organization", "previews": [], "headers": [], @@ -28647,7 +29228,7 @@ "url": "/users/{username}/orgs", "isDeprecated": false, "deprecationDate": null, - "description": "List [public organization memberships](https://docs.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", + "description": "List [public organization memberships](https://docs.github.com/enterprise-server@3.6/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List organizations for the authenticated user](https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#list-organizations-for-the-authenticated-user) API instead.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#list-organizations-for-a-user", "previews": [], "headers": [], @@ -28999,76 +29580,89 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "List deliveries for an organization webhook", + "scope": "orgs", + "id": "listWebhookDeliveries", + "method": "GET", + "url": "/orgs/{org}/hooks/{hook_id}/deliveries", + "isDeprecated": false, + "deprecationDate": null, + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#list-deliveries-for-an-organization-webhook", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "hook_id", + "description": "The unique identifier of the hook.", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "cursor", + "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List deliveries for an organization webhook", - "scope": "orgs", - "id": "listWebhookDeliveries", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}/deliveries", - "isDeprecated": false, - "deprecationDate": null, - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#list-deliveries-for-an-organization-webhook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "PATH", "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "The unique identifier of the hook.", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "The number of results per page (max 100).", - "in": "QUERY", - "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -29078,10 +29672,10 @@ "deprecated": null }, { - "name": "cursor", - "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors.", + "name": "redelivery", + "description": "", "in": "QUERY", - "type": "string", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -29278,7 +29872,11 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 400, "description": "Bad Request", "examples": null }, { "code": 400, "description": "Bad Request", "examples": null }, { @@ -29520,7 +30118,7 @@ }, { "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.", + "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, @@ -29606,7 +30204,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/orgs/#update-an-organization", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#update-an-organization", "previews": [], "headers": [], "parameters": [ @@ -29768,7 +30366,7 @@ }, { "name": "members_can_create_internal_repositories", - "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "description": "Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.6/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -29781,7 +30379,7 @@ }, { "name": "members_can_create_private_repositories", - "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "description": "Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.6/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -29794,7 +30392,7 @@ }, { "name": "members_can_create_public_repositories", - "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "description": "Whether organization members can create public repositories, which are visible to anyone. For more information, see \"[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.6/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -31326,7 +31924,7 @@ "description": "Response", "examples": [ { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}]" + "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":true}]" } ] }, @@ -32058,7 +32656,7 @@ "url": "/repos/{owner}/{repo}/pulls", "isDeprecated": false, "deprecationDate": 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/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/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#create-a-pull-request", "previews": [], "headers": [], @@ -32143,7 +32741,7 @@ }, { "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.6/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", "in": "BODY", "type": "boolean", "required": false, @@ -32156,7 +32754,7 @@ }, { "name": "draft", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://docs.github.com/enterprise-server@3.6/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", "in": "BODY", "type": "boolean", "required": false, @@ -32187,7 +32785,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" } ] }, @@ -32208,7 +32806,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", "isDeprecated": false, "deprecationDate": 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/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#create-a-reply-for-a-review-comment", "previews": [], "headers": [], @@ -32301,7 +32899,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", "isDeprecated": false, "deprecationDate": null, - "description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/pulls#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 v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/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": "This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/pulls#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/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/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.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#create-a-review-for-a-pull-request", "previews": [], "headers": [], @@ -32516,7 +33114,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.6/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", + "description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.6/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#create-a-review-comment-for-a-pull-request", "previews": [], "headers": [], @@ -32614,7 +33212,7 @@ }, { "name": "side", - "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "description": "In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://docs.github.com/enterprise-server@3.6/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", "in": "BODY", "type": "string", "required": false, @@ -32640,7 +33238,7 @@ }, { "name": "start_line", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.6/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", "in": "BODY", "type": "integer", "required": false, @@ -32653,7 +33251,7 @@ }, { "name": "start_side", - "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "description": "**Required when using multi-line comments unless using `in_reply_to`**. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://docs.github.com/enterprise-server@3.6/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", "in": "BODY", "type": "string", "required": false, @@ -32960,7 +33558,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.6/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server 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/enterprise-server@3.6/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 Enterprise Server 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/enterprise-server@3.6/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/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server 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/enterprise-server@3.6/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 Enterprise Server 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/enterprise-server@3.6/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/enterprise-server@3.6/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/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#get-a-pull-request", "previews": [], "headers": [], @@ -33011,7 +33609,7 @@ "description": "Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.6/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" } ] }, @@ -33177,7 +33775,7 @@ "url": "/repos/{owner}/{repo}/pulls", "isDeprecated": false, "deprecationDate": 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": "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests", "previews": [], "headers": [], @@ -34116,7 +34714,7 @@ }, { "name": "merge_method", - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", + "description": "The merge method to use.", "in": "BODY", "type": "string", "required": false, @@ -34479,7 +35077,7 @@ "url": "/repos/{owner}/{repo}/pulls/{pull_number}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/pulls/#update-a-pull-request", "previews": [], "headers": [], @@ -34577,7 +35175,7 @@ }, { "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://docs.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "description": "Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.6/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", "in": "BODY", "type": "boolean", "required": false, @@ -34595,7 +35193,7 @@ "description": "Response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"allow_forking\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"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,\"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_merge_commit\":true,\"forks\":123,\"open_issues\":123,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"url\":\"https://api.github.com/licenses/mit\",\"spdx_id\":\"MIT\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"watchers\":123}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"auto_merge\":null,\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" } ] }, @@ -37375,8 +37973,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#add-app-access-restrictions", + "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/enterprise-server@3.6/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.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#add-app-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -37408,7 +38006,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -37549,8 +38147,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#add-status-check-contexts", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#add-status-check-contexts", "previews": [], "headers": [], "parameters": [ @@ -37582,7 +38180,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -37635,8 +38233,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": 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 teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#add-team-access-restrictions", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#add-team-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -37668,7 +38266,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -37719,8 +38317,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": 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 people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#add-user-access-restrictions", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#add-user-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -37752,7 +38350,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -38044,7 +38642,7 @@ "url": "/repos/{owner}/{repo}/compare/{basehead}", "isDeprecated": false, "deprecationDate": null, - "description": "The `basehead` param is comprised of two parts: `base` and `head`. Both must be branch names in `repo`. To compare branches across other repositories in the same network as `repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://docs.github.com/enterprise-server@3.6/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, 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\n**Working with large comparisons**\n\nTo process a response with a large number of commits, you can use (`per_page` or `page`) to paginate the results. When using paging, the list of changed files is only returned with page 1, but includes all changed files for the entire comparison. For more information on working with pagination, see \"[Traversing with pagination](/rest/guides/traversing-with-pagination).\"\n\nWhen calling this API without any paging parameters (`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. When a paging parameter is specified, the first commit in the returned list of each page is the earliest.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\n| Name | Type | Description |\n| ---- | ---- | ----------- |\n| `verified` | `boolean` | Indicates whether GitHub considers the signature in this commit to be verified. |\n| `reason` | `string` | The reason for verified value. Possible values and their meanings are enumerated in table below. |\n| `signature` | `string` | The signature that was extracted from the commit. |\n| `payload` | `string` | The value that was signed. |\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ----- | ----------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "description": "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/enterprise-server@3.6/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/enterprise-server@3.6/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/enterprise-server@3.6/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 her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/commits/commits#compare-two-commits", "previews": [], "headers": [], @@ -38103,7 +38701,7 @@ }, { "name": "basehead", - "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.", + "description": "The base branch and head branch to compare. This parameter expects the format `BASE...HEAD`. Both must be branch names in `repo`. To compare with a branch that exists in a different repository in the same network as `repo`, the `basehead` parameter expects the format `USERNAME:BASE...USERNAME:HEAD`.", "in": "PATH", "type": "string", "required": true, @@ -38236,7 +38834,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", "isDeprecated": false, "deprecationDate": null, - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/commits/comments#create-a-commit-comment", "previews": [], "headers": [], @@ -38360,8 +38958,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-commit-signature-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#create-commit-signature-protection", "previews": [], "headers": [], "parameters": [ @@ -38393,7 +38991,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -38546,7 +39144,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "You can create a read-only deploy key.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-a-deploy-key", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deploy-keys#create-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -38604,7 +39202,7 @@ }, { "name": "read_only", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/articles/permission-levels-for-a-user-account-repository/).\"", + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.6/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.6/articles/permission-levels-for-a-user-account-repository/).\"", "in": "BODY", "type": "boolean", "required": false, @@ -38643,7 +39241,7 @@ "isDeprecated": false, "deprecationDate": 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 Enterprise Server 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/enterprise-server@3.6/rest/commits/statuses) for every submitted context must be in a `success`\nstate. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to\nspecify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do\nnot require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text\nfield that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might\nbe `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an\napplication with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref.\n\n#### Merged branch response\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating\na deployment. This auto-merge happens when:\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master` in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful\nresponse.\n\n#### Merge conflict response\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't\nbe merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\n#### Failed commit status checks\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success`\nstatus for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-a-deployment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deployments/deployments#create-a-deployment", "previews": [], "headers": [], "parameters": [ @@ -38924,7 +39522,7 @@ "isDeprecated": false, "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-a-deployment-status", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deployments/statuses#create-a-deployment-status", "previews": [], "headers": [], "parameters": [ @@ -39093,7 +39691,7 @@ "url": "/repos/{owner}/{repo}/dispatches", "isDeprecated": false, "deprecationDate": null, - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub Enterprise Server 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/enterprise-server@3.6/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 Enterprise Server 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/enterprise-server@3.6/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/enterprise-server@3.6/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n - GitHub Apps with both `metadata:read` and `contents:read&write` permissions.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-a-repository-dispatch-event", "previews": [], "headers": [], @@ -39139,7 +39737,7 @@ }, { "name": "client_payload", - "description": "JSON payload with extra information about the webhook event that your action or workflow may use.", + "description": "JSON payload with extra information about the webhook event that your action or workflow may use. The maximum number of top-level properties is 10.", "in": "BODY", "type": "object", "required": false, @@ -39278,6 +39876,19 @@ "alias": null, "deprecated": null }, + { + "name": "has_discussions", + "description": "Whether discussions are enabled.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "team_id", "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", @@ -39657,7 +40268,7 @@ }, { "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.", + "description": "The visibility of the repository. **Note**: For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://docs.github.com/enterprise-server@3.6/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "in": "BODY", "type": "string", "required": false, @@ -39707,6 +40318,19 @@ "alias": null, "deprecated": null }, + { + "name": "has_downloads", + "description": "Whether downloads are enabled.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "is_template", "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", @@ -39761,7 +40385,7 @@ }, { "name": "license_template", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://docs.github.com/enterprise-server@3.6/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", "in": "BODY", "type": "string", "required": false, @@ -39931,7 +40555,7 @@ "isDeprecated": false, "deprecationDate": 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 \"[Secrets](/rest/reference/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-or-update-an-environment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deployments/environments#create-or-update-an-environment", "previews": [], "headers": [], "parameters": [ @@ -40330,7 +40954,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, - "description": "Configures a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).\"", + "description": "Configures a GitHub Enterprise Server 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 `administrative:write` and `pages:write` permissions.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/pages#create-a-github-pages-site", "previews": [], "headers": [], @@ -40441,7 +41065,7 @@ "url": "/repos/{owner}/{repo}/releases", "isDeprecated": false, "deprecationDate": null, - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-a-release", "previews": [], "headers": [], @@ -41098,8 +41722,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "isDeprecated": false, "deprecationDate": 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\nDisables the ability to restrict who can push to this branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-access-restrictions", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#delete-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -41131,7 +41755,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -41154,8 +41778,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "deprecationDate": 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\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-admin-branch-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#delete-admin-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -41187,7 +41811,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -41214,7 +41838,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "You must authenticate using an access token with the repo scope to use this endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-an-environment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deployments/environments#delete-an-environment", "previews": [], "headers": [], "parameters": [ @@ -41330,8 +41954,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-branch-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#delete-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -41363,7 +41987,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -41448,8 +42072,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-commit-signature-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#delete-commit-signature-protection", "previews": [], "headers": [], "parameters": [ @@ -41481,7 +42105,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -41508,7 +42132,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Deploy keys are immutable. If you need to update a key, remove the key and create a new one instead.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-a-deploy-key", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deploy-keys#delete-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -41563,8 +42187,8 @@ "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.6/rest/reference/repos/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-a-deployment-status).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-a-deployment", + "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/enterprise-server@3.6/rest/deployments/deployments/#create-a-deployment)\" and \"[Create a deployment status](https://docs.github.com/enterprise-server@3.6/rest/deployments/deployment-statuses#create-a-deployment-status).\"", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deployments/deployments#delete-a-deployment", "previews": [], "headers": [], "parameters": [ @@ -41943,7 +42567,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Deletes a a GitHub Enterprise Server 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 `administrative:write` and `pages:write` permissions.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/pages#delete-a-github-pages-site", "previews": [], "headers": [], @@ -41995,8 +42619,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#delete-pull-request-review-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#delete-pull-request-review-protection", "previews": [], "headers": [], "parameters": [ @@ -42028,7 +42652,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -42285,7 +42909,7 @@ "url": "/repos/{owner}/{repo}/lfs", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Disables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#disable-git-lfs-for-a-repository", "previews": [], "headers": [], @@ -42328,7 +42952,7 @@ "url": "/repos/{owner}/{repo}/tarball/{ref}", "isDeprecated": false, "deprecationDate": null, - "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", + "description": "Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n**Note**: For private repositories, these links are temporary and expire after five minutes.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#download-a-repository-archive", "previews": [], "headers": [], @@ -42384,7 +43008,7 @@ "url": "/repos/{owner}/{repo}/zipball/{ref}", "isDeprecated": false, "deprecationDate": null, - "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", + "description": "Gets a redirect URL to download a zip archive for a repository. If you omit `:ref`, the repository’s default branch (usually\n`main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use\nthe `Location` header to make a second `GET` request.\n\n**Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#download-a-repository-archive", "previews": [], "headers": [], @@ -42440,7 +43064,7 @@ "url": "/repos/{owner}/{repo}/lfs", "isDeprecated": false, "deprecationDate": null, - "description": "", + "description": "Enables Git LFS for a repository. Access tokens must have the `admin:enterprise` scope.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#enable-git-lfs-for-a-repository", "previews": [], "headers": [], @@ -42473,7 +43097,11 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 403, "description": "We will return a 403 with one of the following messages:\n\n- Git LFS support not enabled because Git LFS is globally disabled.\n- Git LFS support not enabled because Git LFS is disabled for the root repository in the network.\n- Git LFS support not enabled because Git LFS is disabled for .", @@ -42596,7 +43224,7 @@ "url": "/repos/{owner}/{repo}", "isDeprecated": false, "deprecationDate": null, - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.\n\n**Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.6/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-a-repository", "previews": [], "headers": [], @@ -42634,7 +43262,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\":{\"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}}" + "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\"}}}}" } ] }, @@ -42652,8 +43280,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "isDeprecated": false, "deprecationDate": 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 who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-access-restrictions", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch.\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -42685,7 +43313,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -42719,8 +43347,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-admin-branch-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-admin-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -42752,7 +43380,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -42864,8 +43492,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-all-status-check-contexts", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-all-status-check-contexts", "previews": [], "headers": [], "parameters": [ @@ -42897,7 +43525,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -43005,8 +43633,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-apps-with-access-to-the-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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#list-apps-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -43038,7 +43666,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -43140,7 +43768,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-a-branch", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branches#get-a-branch", "previews": [], "headers": [], "parameters": [ @@ -43172,7 +43800,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -43207,8 +43835,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-branch-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -43240,7 +43868,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -43312,7 +43940,11 @@ "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", "examples": [{ "data": "[[1302998400,1124,-435]]" }] }, - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 204, "description": "A header with no content is returned.", @@ -43631,7 +44263,11 @@ } ] }, - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 204, "description": "A header with no content is returned.", @@ -43715,8 +44351,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "deprecationDate": 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\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-commit-signature-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/enterprise-server@3.6/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-commit-signature-protection", "previews": [], "headers": [], "parameters": [ @@ -43748,7 +44384,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -43841,13 +44477,24 @@ } ], "responses": [ - { "code": 200, "description": "Response", "examples": null }, { "code": 200, "description": "Response", "examples": [ { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" + "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\\\nIHdvcmtmbG93Lgo=\\\\n\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" + }, + { + "data": "{\"type\":\"dir\",\"size\":0,\"name\":\"src\",\"path\":\"src\",\"sha\":\"2962be1c94eaae9794b3080790ec9d74b2fa8358\",\"url\":\"https://api.github.com/repos/octocat/octorepo/contents/src?ref=main\",\"git_url\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octocat/octorepo/blob/main/src\",\"download_url\":\"https://raw.githubusercontent.com/octocat/octorepo/main/src\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/octorepo/contents/src\",\"git\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octocat/octorepo/blob/main/src\"},\"entries\":[{\"type\":\"file\",\"size\":625,\"name\":\"app.js\",\"path\":\"src/app.js\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octocat/octorepo/contents/src/app.js\",\"git_url\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octocat/octorepo/blob/main/src/app.js\",\"download_url\":\"https://raw.githubusercontent.com/octocat/octorepo/main/src/app.js\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/octorepo/contents/src/app.js\",\"git\":\"https://api.github.com/repos/octocat/octorepo/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octocat/octorepo/blob/main/src/app.js\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"images\",\"path\":\"src/images\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octocat/octorepo/contents/src/images\",\"git_url\":\"https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octocat/octorepo/tree/main/src/images\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octocat/octorepo/contents/src/images\",\"git\":\"https://api.github.com/repos/octocat/octorepo/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octocat/octorepo/tree/main/src/images\"}}]}" + } + ] + }, + { + "code": 200, + "description": "Response", + "examples": [ + { + "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"IyBZb2dhIEJvmsgaW4gcHJvZ3Jlc3MhIEZlZWwgdAoKOndhcm5pbmc6IFdvc\\\\nZnJlZSBmUgdG8gY0byBjaGVjayBvdXQgdGhlIGFwcCwgYnV0IGJlIHN1c29t\\\\nZSBiYWNrIG9uY2UgaXQgaXMgY29tcGxldGUuCgpBIHdlYiBhcHAgdGhhdCBs\\\\nZWFkcyB5b3UgdGhyb3VnaCBhIHlvZ2Egc2Vzc2lvbi4KCltXb3Jrb3V0IG5v\\\\ndyFdKGh0dHBzOi8vc2tlZHdhcmRzODguZ2l0aHViLmlvL3lvZ2EvKQoKPGlt\\\\nZyBzcmM9InNyYy9pbWFnZXMvbWFza2FibGVfaWNvbl81MTIucG5nIiBhbHQ9\\\\nImJvdCBsaWZ0aW5nIHdlaWdodHMiIHdpZHRoPSIxMDAiLz4KCkRvIHlvdSBo\\\\nYXZlIGZlZWRiYWNrIG9yIGlkZWFzIGZvciBpbXByb3ZlbWVudD8gW09wZW4g\\\\nYW4gaXNzdWVdKGh0dHBzOi8vZ2l0aHViLmNvbS9za2Vkd2FyZHM4OC95b2dh\\\\nL2lzc3Vlcy9uZXcpLgoKV2FudCBtb3JlIGdhbWVzPyBWaXNpdCBbQ25TIEdh\\\\nbWVzXShodHRwczovL3NrZWR3YXJkczg4LmdpdGh1Yi5pby9wb3J0Zm9saW8v\\\\nKS4KCiMjIERldmVsb3BtZW50CgpUbyBhZGQgYSBuZXcgcG9zZSwgYWRkIGFu\\\\nIGVudHJ5IHRvIHRoZSByZWxldmFudCBmaWxlIGluIGBzcmMvYXNhbmFzYC4K\\\\nClRvIGJ1aWxkLCBydW4gYG5wbSBydW4gYnVpbGRgLgoKVG8gcnVuIGxvY2Fs\\\\nbHkgd2l0aCBsaXZlIHJlbG9hZGluZyBhbmQgbm8gc2VydmljZSB3b3JrZXIs\\\\nIHJ1biBgbnBtIHJ1biBkZXZgLiAoSWYgYSBzZXJ2aWNlIHdvcmtlciB3YXMg\\\\ncHJldmlvdXNseSByZWdpc3RlcmVkLCB5b3UgY2FuIHVucmVnaXN0ZXIgaXQg\\\\naW4gY2hyb21lIGRldmVsb3BlciB0b29sczogYEFwcGxpY2F0aW9uYCA+IGBT\\\\nZXJ2aWNlIHdvcmtlcnNgID4gYFVucmVnaXN0ZXJgLikKClRvIHJ1biBsb2Nh\\\\nbGx5IGFuZCByZWdpc3RlciB0aGUgc2VydmljZSB3b3JrZXIsIHJ1biBgbnBt\\\\nIHN0YXJ0YC4KClRvIGRlcGxveSwgcHVzaCB0byBgbWFpbmAgb3IgbWFudWFs\\\\nbHkgdHJpZ2dlciB0aGUgYC5naXRodWIvd29ya2Zsb3dzL2RlcGxveS55bWxg\\\\nIHdvcmtmbG93Lgo=\\\\n\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" }, { "data": "[{\"type\":\"file\",\"size\":625,\"name\":\"octokit.rb\",\"path\":\"lib/octokit.rb\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb\",\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"octokit\",\"path\":\"lib/octokit\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\"}}]" @@ -43916,7 +44563,11 @@ } ] }, - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 204, "description": "A header with no content is returned.", @@ -43934,7 +44585,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-a-deploy-key", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deploy-keys#get-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -44001,7 +44652,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-a-deployment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deployments/deployments#get-a-deployment", "previews": [], "headers": [], "parameters": [ @@ -44147,7 +44798,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Users with pull access can view a deployment status for a deployment:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-a-deployment-status", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deployments/statuses#get-a-deployment-status", "previews": [], "headers": [], "parameters": [ @@ -44227,7 +44878,7 @@ "isDeprecated": false, "deprecationDate": 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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-an-environment", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deployments/environments#get-an-environment", "previews": [], "headers": [], "parameters": [ @@ -44572,8 +45223,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-pull-request-review-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-pull-request-review-protection", "previews": [], "headers": [], "parameters": [ @@ -44605,7 +45256,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -45051,8 +45702,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-status-checks-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#get-status-checks-protection", "previews": [], "headers": [], "parameters": [ @@ -45084,7 +45735,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -45118,8 +45769,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": 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 teams who have push access to this branch. The list includes child teams.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-teams-with-access-to-the-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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#list-teams-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -45151,7 +45802,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -45185,8 +45836,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": 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 people who have push access to this branch.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-users-with-access-to-the-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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#list-users-with-access-to-the-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -45218,7 +45869,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -45538,7 +46189,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-branches", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branches#list-branches", "previews": [], "headers": [], "parameters": [ @@ -45630,7 +46281,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "isDeprecated": false, "deprecationDate": 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\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/commits/commits#list-branches-for-head-commit", "previews": [], "headers": [], @@ -45826,19 +46477,6 @@ "alias": null, "deprecated": null }, - { - "name": "permission", - "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["pull", "triage", "push", "maintain", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "per_page", "description": "The number of results per page (max 100).", @@ -46185,7 +46823,7 @@ }, { "name": "sha", - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).", "in": "QUERY", "type": "string", "required": false, @@ -46301,7 +46939,7 @@ "url": "/repos/{owner}/{repo}/contributors", "isDeprecated": false, "deprecationDate": null, - "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", + "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-repository-contributors", "previews": [], "headers": [], @@ -46401,7 +47039,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-deploy-keys", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deploy-keys#list-deploy-keys", "previews": [], "headers": [], "parameters": [ @@ -46564,7 +47202,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Users with pull access can view deployment statuses for a deployment:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-deployment-statuses", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deployments/statuses#list-deployment-statuses", "previews": [], "headers": [], "parameters": [ @@ -46657,7 +47295,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Simple filtering of deployments is available via query parameters:", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#list-deployments", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/deployments/deployments#list-deployments", "previews": [], "headers": [], "parameters": [ @@ -46807,7 +47445,7 @@ }, { "name": "affiliation", - "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", + "description": "Comma-separated list of values. Can include: \n * `owner`: Repositories that are owned by the authenticated user. \n * `collaborator`: Repositories that the user has been added to as a collaborator. \n * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.", "in": "QUERY", "type": "string", "required": false, @@ -46963,7 +47601,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`. However, the `internal` value is not yet supported when a GitHub App calls this API with an installation access token.", + "description": "Specifies the types of repositories you want returned. `internal` is not yet supported when a GitHub App calls this endpoint with an installation access token.", "in": "QUERY", "type": "string", "required": false, @@ -47041,7 +47679,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] } @@ -47146,7 +47784,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] } @@ -47582,7 +48220,7 @@ "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "isDeprecated": false, "deprecationDate": null, - "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests.", + "description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, will only return open pull requests associated with the commit.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/commits/commits#list-pull-requests-associated-with-a-commit", "previews": [], "headers": [], @@ -48124,6 +48762,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "redelivery", + "description": "", + "in": "QUERY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -48235,7 +48886,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#merge-a-branch", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branches#merge-a-branch", "previews": [], "headers": [], "parameters": [ @@ -48348,7 +48999,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "Sync a branch of a forked repository to keep it up-to-date with the upstream repository.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#sync-a-fork-branch-with-the-upstream-repository", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository", "previews": [], "headers": [], "parameters": [ @@ -48541,7 +49192,11 @@ } ], "responses": [ - { "code": 202, "description": "Accepted", "examples": null }, + { + "code": 202, + "description": "Accepted", + "examples": [{ "data": "null" }] + }, { "code": 400, "description": "Bad Request", "examples": null }, { "code": 400, "description": "Bad Request", "examples": null }, { @@ -48560,8 +49215,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#remove-app-access-restrictions", + "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/enterprise-server@3.6/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.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#remove-app-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -48593,7 +49248,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -48700,8 +49355,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#remove-status-check-contexts", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#remove-status-check-contexts", "previews": [], "headers": [], "parameters": [ @@ -48733,7 +49388,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -48781,8 +49436,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#remove-status-check-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#remove-status-check-protection", "previews": [], "headers": [], "parameters": [ @@ -48814,7 +49469,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -48837,8 +49492,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": 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 a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#remove-team-access-restrictions", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#remove-team-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -48870,7 +49525,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -48921,8 +49576,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": 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 a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#remove-user-access-restrictions", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#remove-user-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -48954,7 +49609,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -49006,7 +49661,7 @@ "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.6/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.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#rename-a-branch", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branches#rename-a-branch", "previews": [], "headers": [], "parameters": [ @@ -49038,7 +49693,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -49214,8 +49869,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "deprecationDate": 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\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#set-admin-branch-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#set-admin-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -49247,7 +49902,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -49280,8 +49935,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "deprecationDate": 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.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#set-app-access-restrictions", + "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/enterprise-server@3.6/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.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#set-app-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -49313,7 +49968,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -49364,8 +50019,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "deprecationDate": null, - "description": "Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#set-status-check-contexts", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#set-status-check-contexts", "previews": [], "headers": [], "parameters": [ @@ -49397,7 +50052,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -49445,8 +50100,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "deprecationDate": 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 teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#set-team-access-restrictions", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#set-team-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -49478,7 +50133,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -49529,8 +50184,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "deprecationDate": 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 people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#set-user-access-restrictions", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#set-user-access-restrictions", "previews": [], "headers": [], "parameters": [ @@ -49562,7 +50217,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -49672,7 +50327,7 @@ "url": "/repos/{owner}/{repo}/transfer", "isDeprecated": false, "deprecationDate": 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/).", + "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/enterprise-server@3.6/articles/about-repository-transfers/).", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#transfer-a-repository", "previews": [], "headers": [], @@ -49752,7 +50407,7 @@ "isDeprecated": false, "deprecationDate": null, "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#replace-all-repository-topics) endpoint.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos/#update-a-repository", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/repos/repos#update-a-repository", "previews": [], "headers": [], "parameters": [ @@ -49823,7 +50478,7 @@ }, { "name": "private", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.6/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "in": "BODY", "type": "boolean", "required": false, @@ -49836,7 +50491,7 @@ }, { "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"", + "description": "The visibility of the repository.", "in": "BODY", "type": "string", "required": false, @@ -49847,97 +50502,6 @@ "alias": null, "deprecated": null }, - { - "name": "security_and_analysis", - "description": "Specify which security and analysis features to enable or disable for the repository.\n\nTo use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see \"[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.6/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization).\"\n\nFor example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:\n`{ \"security_and_analysis\": {\"advanced_security\": { \"status\": \"enabled\" } } }`.\n\nYou can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.advanced_security", - "description": "Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see \"[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.advanced_security.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning", - "description": "Use the `status` property to enable or disable secret scanning for this repository. For more information, see \"[About secret scanning](/code-security/secret-security/about-secret-scanning).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning_push_protection", - "description": "Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see \"[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning).\"", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "security_and_analysis.secret_scanning_push_protection.status", - "description": "Can be `enabled` or `disabled`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "has_issues", "description": "Either `true` to enable issues for this repository or `false` to disable them.", @@ -50042,19 +50606,6 @@ "alias": null, "deprecated": null }, - { - "name": "allow_auto_merge", - "description": "Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "delete_branch_on_merge", "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", @@ -50148,7 +50699,7 @@ }, { "name": "archived", - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "description": "Whether to archive this repository. **Note**: You cannot unarchive repositories through the API.", "in": "BODY", "type": "boolean", "required": false, @@ -50215,8 +50766,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "deprecationDate": 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\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#update-branch-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#update-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -50248,7 +50799,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -50430,7 +50981,7 @@ }, { "name": "required_pull_request_reviews.require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) review them.", + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.6/articles/about-code-owners/) review them.", "in": "BODY", "type": "boolean", "required": false, @@ -50560,7 +51111,7 @@ }, { "name": "required_linear_history", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", + "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.6/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -50573,7 +51124,7 @@ }, { "name": "allow_force_pushes", - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", + "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.6/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", "in": "BODY", "type": "boolean", "required": false, @@ -50586,7 +51137,7 @@ }, { "name": "allow_deletions", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", + "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.6/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", "in": "BODY", "type": "boolean", "required": false, @@ -50824,7 +51375,7 @@ "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "deprecationDate": null, - "description": "Updates information for a GitHub Enterprise Server Pages site. For more information, see \"[About GitHub Pages](/github/working-with-github-pages/about-github-pages).", + "description": "Updates information for a GitHub Enterprise Server 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 `administrative:write` and `pages:write` permissions.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/pages#update-information-about-a-github-pages-site", "previews": [], "headers": [], @@ -50857,7 +51408,7 @@ }, { "name": "cname", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/).\"", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.6/articles/using-a-custom-domain-with-github-pages/).\"", "in": "BODY", "type": "string", "required": false, @@ -50881,19 +51432,6 @@ "alias": null, "deprecated": null }, - { - "name": "public", - "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "build_type", "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", @@ -51021,8 +51559,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "deprecationDate": 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\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#update-pull-request-review-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#update-pull-request-review-protection", "previews": [], "headers": [], "parameters": [ @@ -51054,7 +51592,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -51132,7 +51670,7 @@ }, { "name": "require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://docs.github.com/articles/about-code-owners/) have reviewed.", + "description": "Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.6/articles/about-code-owners/) have reviewed.", "in": "BODY", "type": "boolean", "required": false, @@ -51484,8 +52022,8 @@ "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "deprecationDate": 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\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#update-status-check-protection", + "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/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/branches/branch-protection#update-status-check-protection", "previews": [], "headers": [], "parameters": [ @@ -51517,7 +52055,7 @@ }, { "name": "branch", - "description": "The name of the branch.", + "description": "The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.6/graphql).", "in": "PATH", "type": "string", "required": true, @@ -52177,7 +52715,7 @@ "url": "/search/commits", "isDeprecated": false, "deprecationDate": null, - "description": "Find commits via various criteria on the default branch (usually `master`). This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/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/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/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/enterprise-server@3.6/rest/reference/search#search-commits", "previews": [], "headers": [], @@ -52270,7 +52808,7 @@ "url": "/search/issues", "isDeprecated": false, "deprecationDate": null, - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\n`q=windows+label:bug+language:python+state:open&sort=created&order=asc`\n\nThis query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results.\n\n**Note:** For [user-to-server](https://docs.github.com/enterprise-server@3.6/developers/apps/identifying-and-authorizing-users-for-github-apps#user-to-server-requests) GitHub App requests, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see \"[Searching only issues or pull requests](https://docs.github.com/enterprise-server@3.6/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/search#search-issues-and-pull-requests", "previews": [], "headers": [], @@ -52502,7 +53040,7 @@ "parameters": [ { "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.6/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub Enterprise Server. The REST API supports the same qualifiers as the web interface for GitHub Enterprise Server. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/enterprise-server@3.6/rest/reference/search#constructing-a-search-query). See \"[Searching for repositories](https://docs.github.com/enterprise-server@3.6/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", "in": "QUERY", "type": "string", "required": true, @@ -52594,7 +53132,7 @@ "url": "/search/topics", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", + "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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#pagination). See \"[Searching topics](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/search#text-match-metadata).\n\nFor example, if you want to search for topics related to Ruby that are featured on https://github.com/topics. Your query might look like this:\n\n`q=ruby+is:featured`\n\nThis query searches for topics with the keyword `ruby` and limits the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/search#search-topics", "previews": [], "headers": [], @@ -52931,7 +53469,7 @@ }, { "name": "before", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results before this cursor.", "in": "QUERY", "type": "string", "required": false, @@ -52944,7 +53482,7 @@ }, { "name": "after", - "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results after this cursor.", "in": "QUERY", "type": "string", "required": false, @@ -53469,7 +54007,7 @@ "url": "/teams/{team_id}/members/{username}", "isDeprecated": true, "deprecationDate": "2020-01-21", - "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/enterprise-server@3.6/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](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/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.6/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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-verbs).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#add-team-member-legacy", "previews": [], "headers": [], @@ -53525,7 +54063,7 @@ "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.6/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#add-or-update-team-membership-for-a-user", "previews": [], "headers": [], @@ -53614,7 +54152,7 @@ "url": "/teams/{team_id}/memberships/{username}", "isDeprecated": true, "deprecationDate": "2020-01-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 [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.6/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.6/rest/reference/teams#add-or-update-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.6/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy", "previews": [], "headers": [], @@ -53844,7 +54382,7 @@ "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "isDeprecated": false, "deprecationDate": 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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "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/enterprise-server@3.6/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/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/teams/#add-or-update-team-repository-permissions", "previews": [], "headers": [], @@ -53927,7 +54465,7 @@ "isDeprecated": true, "deprecationDate": "2020-01-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 \"[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.6/rest/reference/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams/#add-or-update-team-repository-permissions-legacy", + "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#add-or-update-team-repository-permissions-legacy", "previews": [], "headers": [], "parameters": [ @@ -54297,7 +54835,7 @@ "url": "/orgs/{org}/teams", "isDeprecated": false, "deprecationDate": null, - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://docs.github.com/enterprise-server@3.6/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://docs.github.com/enterprise-server@3.6/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#create-a-team", "previews": [], "headers": [], @@ -54369,7 +54907,7 @@ }, { "name": "privacy", - "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", + "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n * `closed` - visible to all members of this organization. \nDefault for child team: `closed`", "in": "BODY", "type": "string", "required": false, @@ -54447,7 +54985,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "isDeprecated": false, "deprecationDate": null, - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#create-a-discussion-comment", "previews": [], "headers": [], @@ -54526,7 +55064,7 @@ "url": "/teams/{team_id}/discussions/{discussion_number}/comments", "isDeprecated": true, "deprecationDate": "2020-01-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 a discussion comment](https://docs.github.com/enterprise-server@3.6/rest/reference/teams#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/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/teams#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/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#create-a-discussion-comment-legacy", "previews": [], "headers": [], @@ -54592,7 +55130,7 @@ "url": "/orgs/{org}/teams/{team_slug}/discussions", "isDeprecated": false, "deprecationDate": null, - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#create-a-discussion", "previews": [], "headers": [], @@ -54684,7 +55222,7 @@ "url": "/teams/{team_id}/discussions", "isDeprecated": true, "deprecationDate": "2020-01-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 a discussion`](https://docs.github.com/enterprise-server@3.6/rest/reference/teams#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/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/reference/teams#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/enterprise-server@3.6/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.6/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/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#create-a-discussion-legacy", "previews": [], "headers": [], @@ -56640,7 +57178,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] } @@ -56706,7 +57244,7 @@ "description": "Response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"https://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"https://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"https://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"https://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"https://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"https://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"https://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"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\":{\"admin\":false,\"push\":false,\"pull\":true}}]" } ] }, @@ -56722,7 +57260,7 @@ "url": "/teams/{team_id}/members/{username}", "isDeprecated": true, "deprecationDate": "2020-01-21", - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.6/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.6/rest/reference/teams#remove-team-membership-for-a-user) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.6/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#remove-team-member-legacy", "previews": [], "headers": [], @@ -56772,7 +57310,7 @@ "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "isDeprecated": false, "deprecationDate": null, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\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 Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.6/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#remove-team-membership-for-a-user", "previews": [], "headers": [], @@ -56835,7 +57373,7 @@ "url": "/teams/{team_id}/memberships/{username}", "isDeprecated": true, "deprecationDate": "2020-01-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 [Remove team membership for a user](https://docs.github.com/enterprise-server@3.6/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/enterprise-server@3.6/rest/reference/teams#remove-team-membership-for-a-user) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.6/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.6/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", "documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/teams#remove-team-membership-for-a-user-legacy", "previews": [], "headers": [], @@ -57518,7 +58056,7 @@ }, { "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", "in": "BODY", "type": "string", "required": false, @@ -57639,7 +58177,7 @@ }, { "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization.", "in": "BODY", "type": "string", "required": false, diff --git a/scripts/update-endpoints/ghe-versions.js b/scripts/update-endpoints/ghe-versions.js index 991f338f..3fe64900 100644 --- a/scripts/update-endpoints/ghe-versions.js +++ b/scripts/update-endpoints/ghe-versions.js @@ -1 +1 @@ -module.exports = ["32", "33", "34", "35", "36"]; +module.exports = ["34", "35", "36"]; diff --git a/src/generated/ghe-32-admin-endpoints.ts b/src/generated/ghe-32-admin-endpoints.ts deleted file mode 100644 index c3a6e044..00000000 --- a/src/generated/ghe-32-admin-endpoints.ts +++ /dev/null @@ -1,136 +0,0 @@ -import { EndpointsDefaultsAndDecorations } from "../types"; -const Endpoints: EndpointsDefaultsAndDecorations = { - enterpriseAdmin: { - addAuthorizedSshKey: ["POST {origin}/setup/api/settings/authorized-keys"], - createEnterpriseServerLicense: ["POST {origin}/setup/api/start"], - createGlobalWebhook: ["POST /admin/hooks"], - createImpersonationOAuthToken: [ - "POST /admin/users/{username}/authorizations", - ], - createOrg: ["POST /admin/organizations"], - createPreReceiveEnvironment: ["POST /admin/pre-receive-environments"], - createPreReceiveHook: ["POST /admin/pre-receive-hooks"], - createUser: ["POST /admin/users"], - deleteGlobalWebhook: ["DELETE /admin/hooks/{hook_id}"], - deleteImpersonationOAuthToken: [ - "DELETE /admin/users/{username}/authorizations", - ], - deletePersonalAccessToken: ["DELETE /admin/tokens/{token_id}"], - deletePreReceiveEnvironment: [ - "DELETE /admin/pre-receive-environments/{pre_receive_environment_id}", - ], - deletePreReceiveHook: [ - "DELETE /admin/pre-receive-hooks/{pre_receive_hook_id}", - ], - deletePublicKey: ["DELETE /admin/keys/{key_ids}"], - deleteUser: ["DELETE /admin/users/{username}"], - demoteSiteAdministrator: ["DELETE /users/{username}/site_admin"], - disableSelectedOrganizationGithubActionsEnterprise: [ - "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - ], - enableOrDisableMaintenanceMode: ["POST {origin}/setup/api/maintenance"], - enableSelectedOrganizationGithubActionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - ], - getAllAuthorizedSshKeys: [ - "GET {origin}/setup/api/settings/authorized-keys", - ], - getAllStats: ["GET /enterprise/stats/all"], - getAllowedActionsEnterprise: [ - "GET /enterprises/{enterprise}/actions/permissions/selected-actions", - ], - getAnnouncement: ["GET /enterprise/announcement"], - getCommentStats: ["GET /enterprise/stats/comments"], - getConfigurationStatus: ["GET {origin}/setup/api/configcheck"], - getDownloadStatusForPreReceiveEnvironment: [ - "GET /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - ], - getGistStats: ["GET /enterprise/stats/gists"], - getGithubActionsPermissionsEnterprise: [ - "GET /enterprises/{enterprise}/actions/permissions", - ], - getGlobalWebhook: ["GET /admin/hooks/{hook_id}"], - getHooksStats: ["GET /enterprise/stats/hooks"], - getIssueStats: ["GET /enterprise/stats/issues"], - getLicenseInformation: ["GET /enterprise/settings/license"], - getMaintenanceStatus: ["GET {origin}/setup/api/maintenance"], - getMilestoneStats: ["GET /enterprise/stats/milestones"], - getOrgStats: ["GET /enterprise/stats/orgs"], - getPagesStats: ["GET /enterprise/stats/pages"], - getPreReceiveEnvironment: [ - "GET /admin/pre-receive-environments/{pre_receive_environment_id}", - ], - getPreReceiveHook: ["GET /admin/pre-receive-hooks/{pre_receive_hook_id}"], - getPreReceiveHookForOrg: [ - "GET /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - ], - getPreReceiveHookForRepo: [ - "GET /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - ], - getPullRequestStats: ["GET /enterprise/stats/pulls"], - getRepoStats: ["GET /enterprise/stats/repos"], - getSettings: ["GET {origin}/setup/api/settings"], - getUserStats: ["GET /enterprise/stats/users"], - listGlobalWebhooks: ["GET /admin/hooks"], - listPersonalAccessTokens: ["GET /admin/tokens"], - listPreReceiveEnvironments: ["GET /admin/pre-receive-environments"], - listPreReceiveHooks: ["GET /admin/pre-receive-hooks"], - listPreReceiveHooksForOrg: ["GET /orgs/{org}/pre-receive-hooks"], - listPreReceiveHooksForRepo: ["GET /repos/{owner}/{repo}/pre-receive-hooks"], - listPublicKeys: ["GET /admin/keys"], - listSelectedOrganizationsEnabledGithubActionsEnterprise: [ - "GET /enterprises/{enterprise}/actions/permissions/organizations", - ], - pingGlobalWebhook: ["POST /admin/hooks/{hook_id}/pings"], - promoteUserToBeSiteAdministrator: ["PUT /users/{username}/site_admin"], - removeAnnouncement: ["DELETE /enterprise/announcement"], - removeAuthorizedSshKey: [ - "DELETE {origin}/setup/api/settings/authorized-keys", - ], - removePreReceiveHookEnforcementForOrg: [ - "DELETE /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - ], - removePreReceiveHookEnforcementForRepo: [ - "DELETE /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - ], - setAllowedActionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions/selected-actions", - ], - setAnnouncement: ["PATCH /enterprise/announcement"], - setGithubActionsPermissionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions", - ], - setSelectedOrganizationsEnabledGithubActionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions/organizations", - ], - setSettings: ["PUT {origin}/setup/api/settings"], - startConfigurationProcess: ["POST {origin}/setup/api/configure"], - startPreReceiveEnvironmentDownload: [ - "POST /admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - ], - suspendUser: ["PUT /users/{username}/suspended"], - syncLdapMappingForTeam: ["POST /admin/ldap/teams/{team_id}/sync"], - syncLdapMappingForUser: ["POST /admin/ldap/users/{username}/sync"], - unsuspendUser: ["DELETE /users/{username}/suspended"], - updateGlobalWebhook: ["PATCH /admin/hooks/{hook_id}"], - updateLdapMappingForTeam: ["PATCH /admin/ldap/teams/{team_id}/mapping"], - updateLdapMappingForUser: ["PATCH /admin/ldap/users/{username}/mapping"], - updateOrgName: ["PATCH /admin/organizations/{org}"], - updatePreReceiveEnvironment: [ - "PATCH /admin/pre-receive-environments/{pre_receive_environment_id}", - ], - updatePreReceiveHook: [ - "PATCH /admin/pre-receive-hooks/{pre_receive_hook_id}", - ], - updatePreReceiveHookEnforcementForOrg: [ - "PATCH /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - ], - updatePreReceiveHookEnforcementForRepo: [ - "PATCH /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - ], - updateUsernameForUser: ["PATCH /admin/users/{username}"], - upgradeLicense: ["POST {origin}/setup/api/upgrade"], - }, -}; - -export default Endpoints; diff --git a/src/generated/ghe-32-endpoints.ts b/src/generated/ghe-32-endpoints.ts deleted file mode 100644 index 28c9b4f9..00000000 --- a/src/generated/ghe-32-endpoints.ts +++ /dev/null @@ -1,1556 +0,0 @@ -import { EndpointsDefaultsAndDecorations } from "../types"; -const Endpoints: EndpointsDefaultsAndDecorations = { - actions: { - addSelectedRepoToOrgSecret: [ - "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - ], - cancelWorkflowRun: [ - "POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel", - ], - createOrUpdateEnvironmentSecret: [ - "PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", - ], - createOrUpdateOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}"], - createOrUpdateRepoSecret: [ - "PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}", - ], - createRegistrationTokenForOrg: [ - "POST /orgs/{org}/actions/runners/registration-token", - ], - createRegistrationTokenForRepo: [ - "POST /repos/{owner}/{repo}/actions/runners/registration-token", - ], - createRemoveTokenForOrg: ["POST /orgs/{org}/actions/runners/remove-token"], - createRemoveTokenForRepo: [ - "POST /repos/{owner}/{repo}/actions/runners/remove-token", - ], - createWorkflowDispatch: [ - "POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", - ], - deleteArtifact: [ - "DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - ], - deleteEnvironmentSecret: [ - "DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", - ], - deleteOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}"], - deleteRepoSecret: [ - "DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}", - ], - deleteSelfHostedRunnerFromOrg: [ - "DELETE /orgs/{org}/actions/runners/{runner_id}", - ], - deleteSelfHostedRunnerFromRepo: [ - "DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}", - ], - deleteWorkflowRun: ["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}"], - deleteWorkflowRunLogs: [ - "DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs", - ], - disableSelectedRepositoryGithubActionsOrganization: [ - "DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}", - ], - disableWorkflow: [ - "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", - ], - downloadArtifact: [ - "GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", - ], - downloadJobLogsForWorkflowRun: [ - "GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs", - ], - downloadWorkflowRunLogs: [ - "GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs", - ], - enableSelectedRepositoryGithubActionsOrganization: [ - "PUT /orgs/{org}/actions/permissions/repositories/{repository_id}", - ], - enableWorkflow: [ - "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", - ], - getAllowedActionsOrganization: [ - "GET /orgs/{org}/actions/permissions/selected-actions", - ], - getAllowedActionsRepository: [ - "GET /repos/{owner}/{repo}/actions/permissions/selected-actions", - ], - getArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"], - getEnvironmentPublicKey: [ - "GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key", - ], - getEnvironmentSecret: [ - "GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", - ], - getGithubActionsPermissionsOrganization: [ - "GET /orgs/{org}/actions/permissions", - ], - getGithubActionsPermissionsRepository: [ - "GET /repos/{owner}/{repo}/actions/permissions", - ], - getJobForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"], - getOrgPublicKey: ["GET /orgs/{org}/actions/secrets/public-key"], - getOrgSecret: ["GET /orgs/{org}/actions/secrets/{secret_name}"], - getPendingDeploymentsForRun: [ - "GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - ], - getRepoPublicKey: ["GET /repos/{owner}/{repo}/actions/secrets/public-key"], - getRepoSecret: ["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"], - getReviewsForRun: [ - "GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals", - ], - getSelfHostedRunnerForOrg: ["GET /orgs/{org}/actions/runners/{runner_id}"], - getSelfHostedRunnerForRepo: [ - "GET /repos/{owner}/{repo}/actions/runners/{runner_id}", - ], - getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], - getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], - listArtifactsForRepo: ["GET /repos/{owner}/{repo}/actions/artifacts"], - listEnvironmentSecrets: [ - "GET /repositories/{repository_id}/environments/{environment_name}/secrets", - ], - listJobsForWorkflowRun: [ - "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", - ], - listOrgSecrets: ["GET /orgs/{org}/actions/secrets"], - listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], - listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], - listRunnerApplicationsForOrg: ["GET /orgs/{org}/actions/runners/downloads"], - listRunnerApplicationsForRepo: [ - "GET /repos/{owner}/{repo}/actions/runners/downloads", - ], - listSelectedReposForOrgSecret: [ - "GET /orgs/{org}/actions/secrets/{secret_name}/repositories", - ], - listSelectedRepositoriesEnabledGithubActionsOrganization: [ - "GET /orgs/{org}/actions/permissions/repositories", - ], - listSelfHostedRunnersForOrg: ["GET /orgs/{org}/actions/runners"], - listSelfHostedRunnersForRepo: ["GET /repos/{owner}/{repo}/actions/runners"], - listWorkflowRunArtifacts: [ - "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", - ], - listWorkflowRuns: [ - "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", - ], - listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"], - reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"], - removeSelectedRepoFromOrgSecret: [ - "DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - ], - reviewPendingDeploymentsForRun: [ - "POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - ], - setAllowedActionsOrganization: [ - "PUT /orgs/{org}/actions/permissions/selected-actions", - ], - setAllowedActionsRepository: [ - "PUT /repos/{owner}/{repo}/actions/permissions/selected-actions", - ], - setGithubActionsPermissionsOrganization: [ - "PUT /orgs/{org}/actions/permissions", - ], - setGithubActionsPermissionsRepository: [ - "PUT /repos/{owner}/{repo}/actions/permissions", - ], - setSelectedReposForOrgSecret: [ - "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories", - ], - setSelectedRepositoriesEnabledGithubActionsOrganization: [ - "PUT /orgs/{org}/actions/permissions/repositories", - ], - }, - activity: { - checkRepoIsStarredByAuthenticatedUser: ["GET /user/starred/{owner}/{repo}"], - deleteRepoSubscription: ["DELETE /repos/{owner}/{repo}/subscription"], - deleteThreadSubscription: [ - "DELETE /notifications/threads/{thread_id}/subscription", - ], - getFeeds: ["GET /feeds"], - getRepoSubscription: ["GET /repos/{owner}/{repo}/subscription"], - getThread: ["GET /notifications/threads/{thread_id}"], - getThreadSubscriptionForAuthenticatedUser: [ - "GET /notifications/threads/{thread_id}/subscription", - ], - listEventsForAuthenticatedUser: ["GET /users/{username}/events"], - listNotificationsForAuthenticatedUser: ["GET /notifications"], - listOrgEventsForAuthenticatedUser: [ - "GET /users/{username}/events/orgs/{org}", - ], - listPublicEvents: ["GET /events"], - listPublicEventsForRepoNetwork: ["GET /networks/{owner}/{repo}/events"], - listPublicEventsForUser: ["GET /users/{username}/events/public"], - listPublicOrgEvents: ["GET /orgs/{org}/events"], - listReceivedEventsForUser: ["GET /users/{username}/received_events"], - listReceivedPublicEventsForUser: [ - "GET /users/{username}/received_events/public", - ], - listRepoEvents: ["GET /repos/{owner}/{repo}/events"], - listRepoNotificationsForAuthenticatedUser: [ - "GET /repos/{owner}/{repo}/notifications", - ], - listReposStarredByAuthenticatedUser: ["GET /user/starred"], - listReposStarredByUser: ["GET /users/{username}/starred"], - listReposWatchedByUser: ["GET /users/{username}/subscriptions"], - listStargazersForRepo: ["GET /repos/{owner}/{repo}/stargazers"], - listWatchedReposForAuthenticatedUser: ["GET /user/subscriptions"], - listWatchersForRepo: ["GET /repos/{owner}/{repo}/subscribers"], - markNotificationsAsRead: ["PUT /notifications"], - markRepoNotificationsAsRead: ["PUT /repos/{owner}/{repo}/notifications"], - markThreadAsRead: ["PATCH /notifications/threads/{thread_id}"], - setRepoSubscription: ["PUT /repos/{owner}/{repo}/subscription"], - setThreadSubscription: [ - "PUT /notifications/threads/{thread_id}/subscription", - ], - starRepoForAuthenticatedUser: ["PUT /user/starred/{owner}/{repo}"], - unstarRepoForAuthenticatedUser: ["DELETE /user/starred/{owner}/{repo}"], - }, - apps: { - addRepoToInstallation: [ - "PUT /user/installations/{installation_id}/repositories/{repository_id}", - {}, - { renamed: ["apps", "addRepoToInstallationForAuthenticatedUser"] }, - ], - addRepoToInstallationForAuthenticatedUser: [ - "PUT /user/installations/{installation_id}/repositories/{repository_id}", - ], - checkAuthorization: [ - "GET /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.checkAuthorization() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/apps#check-an-authorization", - }, - ], - checkToken: ["POST /applications/{client_id}/token"], - createContentAttachment: [ - "POST /content_references/{content_reference_id}/attachments", - { mediaType: { previews: ["corsair"] } }, - ], - createContentAttachmentForRepo: [ - "POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", - ], - createFromManifest: ["POST /app-manifests/{code}/conversions"], - createInstallationAccessToken: [ - "POST /app/installations/{installation_id}/access_tokens", - ], - deleteAuthorization: ["DELETE /applications/{client_id}/grant"], - deleteInstallation: ["DELETE /app/installations/{installation_id}"], - deleteToken: ["DELETE /applications/{client_id}/token"], - getAuthenticated: ["GET /app"], - getBySlug: ["GET /apps/{app_slug}"], - getInstallation: ["GET /app/installations/{installation_id}"], - getOrgInstallation: ["GET /orgs/{org}/installation"], - getRepoInstallation: ["GET /repos/{owner}/{repo}/installation"], - getUserInstallation: ["GET /users/{username}/installation"], - getWebhookConfigForApp: ["GET /app/hook/config"], - getWebhookDelivery: ["GET /app/hook/deliveries/{delivery_id}"], - listInstallationReposForAuthenticatedUser: [ - "GET /user/installations/{installation_id}/repositories", - ], - listInstallations: ["GET /app/installations"], - listInstallationsForAuthenticatedUser: ["GET /user/installations"], - listReposAccessibleToInstallation: ["GET /installation/repositories"], - listWebhookDeliveries: ["GET /app/hook/deliveries"], - redeliverWebhookDelivery: [ - "POST /app/hook/deliveries/{delivery_id}/attempts", - ], - removeRepoFromInstallation: [ - "DELETE /user/installations/{installation_id}/repositories/{repository_id}", - {}, - { renamed: ["apps", "removeRepoFromInstallationForAuthenticatedUser"] }, - ], - removeRepoFromInstallationForAuthenticatedUser: [ - "DELETE /user/installations/{installation_id}/repositories/{repository_id}", - ], - resetAuthorization: [ - "POST /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.resetAuthorization() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/apps#reset-an-authorization", - }, - ], - resetToken: ["PATCH /applications/{client_id}/token"], - revokeAuthorizationForApplication: [ - "DELETE /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.revokeAuthorizationForApplication() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/apps#revoke-an-authorization-for-an-application", - }, - ], - revokeGrantForApplication: [ - "DELETE /applications/{client_id}/grants/{access_token}", - {}, - { - deprecated: - "octokit.scim.revokeGrantForApplication() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/apps#revoke-a-grant-for-an-application", - }, - ], - revokeInstallationAccessToken: ["DELETE /installation/token"], - scopeToken: ["POST /applications/{client_id}/token/scoped"], - suspendInstallation: ["PUT /app/installations/{installation_id}/suspended"], - unsuspendInstallation: [ - "DELETE /app/installations/{installation_id}/suspended", - ], - updateWebhookConfigForApp: ["PATCH /app/hook/config"], - }, - checks: { - create: ["POST /repos/{owner}/{repo}/check-runs"], - createSuite: ["POST /repos/{owner}/{repo}/check-suites"], - get: ["GET /repos/{owner}/{repo}/check-runs/{check_run_id}"], - getSuite: ["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}"], - listAnnotations: [ - "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - ], - listForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"], - listForSuite: [ - "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - ], - listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"], - rerequestSuite: [ - "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - ], - setSuitesPreferences: [ - "PATCH /repos/{owner}/{repo}/check-suites/preferences", - ], - update: ["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"], - }, - codeScanning: { - deleteAnalysis: [ - "DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}", - ], - getAlert: ["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"], - getAnalysis: [ - "GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", - ], - getSarif: ["GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"], - listAlertInstances: [ - "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", - ], - listAlertsForRepo: ["GET /repos/{owner}/{repo}/code-scanning/alerts"], - listAlertsInstances: [ - "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", - {}, - { renamed: ["codeScanning", "listAlertInstances"] }, - ], - listRecentAnalyses: ["GET /repos/{owner}/{repo}/code-scanning/analyses"], - updateAlert: [ - "PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - ], - uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"], - }, - codesOfConduct: { - getAllCodesOfConduct: ["GET /codes_of_conduct"], - getConductCode: ["GET /codes_of_conduct/{key}"], - getForRepo: [ - "GET /repos/{owner}/{repo}/community/code_of_conduct", - { mediaType: { previews: ["scarlet-witch"] } }, - { - deprecated: - "octokit.scim.getForRepo() is deprecated, see https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository", - }, - ], - }, - emojis: { get: ["GET /emojis"] }, - enterpriseAdmin: { - addAuthorizedSshKey: ["POST {origin}/setup/api/settings/authorized-keys"], - createEnterpriseServerLicense: ["POST {origin}/setup/api/start"], - createGlobalWebhook: ["POST /admin/hooks"], - createImpersonationOAuthToken: [ - "POST /admin/users/{username}/authorizations", - ], - createOrg: ["POST /admin/organizations"], - createPreReceiveEnvironment: ["POST /admin/pre-receive-environments"], - createPreReceiveHook: ["POST /admin/pre-receive-hooks"], - createUser: ["POST /admin/users"], - deleteGlobalWebhook: ["DELETE /admin/hooks/{hook_id}"], - deleteImpersonationOAuthToken: [ - "DELETE /admin/users/{username}/authorizations", - ], - deletePersonalAccessToken: ["DELETE /admin/tokens/{token_id}"], - deletePreReceiveEnvironment: [ - "DELETE /admin/pre-receive-environments/{pre_receive_environment_id}", - ], - deletePreReceiveHook: [ - "DELETE /admin/pre-receive-hooks/{pre_receive_hook_id}", - ], - deletePublicKey: ["DELETE /admin/keys/{key_ids}"], - deleteUser: ["DELETE /admin/users/{username}"], - demoteSiteAdministrator: ["DELETE /users/{username}/site_admin"], - disableSelectedOrganizationGithubActionsEnterprise: [ - "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - ], - enableOrDisableMaintenanceMode: ["POST {origin}/setup/api/maintenance"], - enableSelectedOrganizationGithubActionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - ], - getAllAuthorizedSshKeys: [ - "GET {origin}/setup/api/settings/authorized-keys", - ], - getAllStats: ["GET /enterprise/stats/all"], - getAllowedActionsEnterprise: [ - "GET /enterprises/{enterprise}/actions/permissions/selected-actions", - ], - getAnnouncement: ["GET /enterprise/announcement"], - getCommentStats: ["GET /enterprise/stats/comments"], - getConfigurationStatus: ["GET {origin}/setup/api/configcheck"], - getDownloadStatusForPreReceiveEnvironment: [ - "GET /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - ], - getGistStats: ["GET /enterprise/stats/gists"], - getGithubActionsPermissionsEnterprise: [ - "GET /enterprises/{enterprise}/actions/permissions", - ], - getGlobalWebhook: ["GET /admin/hooks/{hook_id}"], - getHooksStats: ["GET /enterprise/stats/hooks"], - getIssueStats: ["GET /enterprise/stats/issues"], - getLicenseInformation: ["GET /enterprise/settings/license"], - getMaintenanceStatus: ["GET {origin}/setup/api/maintenance"], - getMilestoneStats: ["GET /enterprise/stats/milestones"], - getOrgStats: ["GET /enterprise/stats/orgs"], - getPagesStats: ["GET /enterprise/stats/pages"], - getPreReceiveEnvironment: [ - "GET /admin/pre-receive-environments/{pre_receive_environment_id}", - ], - getPreReceiveHook: ["GET /admin/pre-receive-hooks/{pre_receive_hook_id}"], - getPreReceiveHookForOrg: [ - "GET /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - ], - getPreReceiveHookForRepo: [ - "GET /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - ], - getPullRequestStats: ["GET /enterprise/stats/pulls"], - getRepoStats: ["GET /enterprise/stats/repos"], - getSettings: ["GET {origin}/setup/api/settings"], - getUserStats: ["GET /enterprise/stats/users"], - listGlobalWebhooks: ["GET /admin/hooks"], - listPersonalAccessTokens: ["GET /admin/tokens"], - listPreReceiveEnvironments: ["GET /admin/pre-receive-environments"], - listPreReceiveHooks: ["GET /admin/pre-receive-hooks"], - listPreReceiveHooksForOrg: ["GET /orgs/{org}/pre-receive-hooks"], - listPreReceiveHooksForRepo: ["GET /repos/{owner}/{repo}/pre-receive-hooks"], - listPublicKeys: ["GET /admin/keys"], - listSelectedOrganizationsEnabledGithubActionsEnterprise: [ - "GET /enterprises/{enterprise}/actions/permissions/organizations", - ], - pingGlobalWebhook: ["POST /admin/hooks/{hook_id}/pings"], - promoteUserToBeSiteAdministrator: ["PUT /users/{username}/site_admin"], - removeAnnouncement: ["DELETE /enterprise/announcement"], - removeAuthorizedSshKey: [ - "DELETE {origin}/setup/api/settings/authorized-keys", - ], - removePreReceiveHookEnforcementForOrg: [ - "DELETE /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - ], - removePreReceiveHookEnforcementForRepo: [ - "DELETE /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - ], - setAllowedActionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions/selected-actions", - ], - setAnnouncement: ["PATCH /enterprise/announcement"], - setGithubActionsPermissionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions", - ], - setSelectedOrganizationsEnabledGithubActionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions/organizations", - ], - setSettings: ["PUT {origin}/setup/api/settings"], - startConfigurationProcess: ["POST {origin}/setup/api/configure"], - startPreReceiveEnvironmentDownload: [ - "POST /admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - ], - suspendUser: ["PUT /users/{username}/suspended"], - syncLdapMappingForTeam: ["POST /admin/ldap/teams/{team_id}/sync"], - syncLdapMappingForUser: ["POST /admin/ldap/users/{username}/sync"], - unsuspendUser: ["DELETE /users/{username}/suspended"], - updateGlobalWebhook: ["PATCH /admin/hooks/{hook_id}"], - updateLdapMappingForTeam: ["PATCH /admin/ldap/teams/{team_id}/mapping"], - updateLdapMappingForUser: ["PATCH /admin/ldap/users/{username}/mapping"], - updateOrgName: ["PATCH /admin/organizations/{org}"], - updatePreReceiveEnvironment: [ - "PATCH /admin/pre-receive-environments/{pre_receive_environment_id}", - ], - updatePreReceiveHook: [ - "PATCH /admin/pre-receive-hooks/{pre_receive_hook_id}", - ], - updatePreReceiveHookEnforcementForOrg: [ - "PATCH /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - ], - updatePreReceiveHookEnforcementForRepo: [ - "PATCH /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - ], - updateUsernameForUser: ["PATCH /admin/users/{username}"], - upgradeLicense: ["POST {origin}/setup/api/upgrade"], - }, - gists: { - checkIsStarred: ["GET /gists/{gist_id}/star"], - create: ["POST /gists"], - createComment: ["POST /gists/{gist_id}/comments"], - delete: ["DELETE /gists/{gist_id}"], - deleteComment: ["DELETE /gists/{gist_id}/comments/{comment_id}"], - fork: ["POST /gists/{gist_id}/forks"], - get: ["GET /gists/{gist_id}"], - getComment: ["GET /gists/{gist_id}/comments/{comment_id}"], - getRevision: ["GET /gists/{gist_id}/{sha}"], - list: ["GET /gists"], - listComments: ["GET /gists/{gist_id}/comments"], - listCommits: ["GET /gists/{gist_id}/commits"], - listForUser: ["GET /users/{username}/gists"], - listForks: ["GET /gists/{gist_id}/forks"], - listPublic: ["GET /gists/public"], - listStarred: ["GET /gists/starred"], - star: ["PUT /gists/{gist_id}/star"], - unstar: ["DELETE /gists/{gist_id}/star"], - update: ["PATCH /gists/{gist_id}"], - updateComment: ["PATCH /gists/{gist_id}/comments/{comment_id}"], - }, - git: { - createBlob: ["POST /repos/{owner}/{repo}/git/blobs"], - createCommit: ["POST /repos/{owner}/{repo}/git/commits"], - createRef: ["POST /repos/{owner}/{repo}/git/refs"], - createTag: ["POST /repos/{owner}/{repo}/git/tags"], - createTree: ["POST /repos/{owner}/{repo}/git/trees"], - deleteRef: ["DELETE /repos/{owner}/{repo}/git/refs/{ref}"], - getBlob: ["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"], - getCommit: ["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"], - getRef: ["GET /repos/{owner}/{repo}/git/ref/{ref}"], - getTag: ["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"], - getTree: ["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"], - listMatchingRefs: ["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"], - updateRef: ["PATCH /repos/{owner}/{repo}/git/refs/{ref}"], - }, - gitignore: { - getAllTemplates: ["GET /gitignore/templates"], - getTemplate: ["GET /gitignore/templates/{name}"], - }, - issues: { - addAssignees: [ - "POST /repos/{owner}/{repo}/issues/{issue_number}/assignees", - ], - addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"], - checkUserCanBeAssigned: ["GET /repos/{owner}/{repo}/assignees/{assignee}"], - create: ["POST /repos/{owner}/{repo}/issues"], - createComment: [ - "POST /repos/{owner}/{repo}/issues/{issue_number}/comments", - ], - createLabel: ["POST /repos/{owner}/{repo}/labels"], - createMilestone: ["POST /repos/{owner}/{repo}/milestones"], - deleteComment: [ - "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}", - ], - deleteLabel: ["DELETE /repos/{owner}/{repo}/labels/{name}"], - deleteMilestone: [ - "DELETE /repos/{owner}/{repo}/milestones/{milestone_number}", - ], - get: ["GET /repos/{owner}/{repo}/issues/{issue_number}"], - getComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"], - getEvent: ["GET /repos/{owner}/{repo}/issues/events/{event_id}"], - getLabel: ["GET /repos/{owner}/{repo}/labels/{name}"], - getMilestone: ["GET /repos/{owner}/{repo}/milestones/{milestone_number}"], - list: ["GET /issues"], - listAssignees: ["GET /repos/{owner}/{repo}/assignees"], - listComments: ["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"], - listCommentsForRepo: ["GET /repos/{owner}/{repo}/issues/comments"], - listEvents: ["GET /repos/{owner}/{repo}/issues/{issue_number}/events"], - listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"], - listEventsForTimeline: [ - "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", - ], - listForAuthenticatedUser: ["GET /user/issues"], - listForOrg: ["GET /orgs/{org}/issues"], - listForRepo: ["GET /repos/{owner}/{repo}/issues"], - listLabelsForMilestone: [ - "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels", - ], - listLabelsForRepo: ["GET /repos/{owner}/{repo}/labels"], - listLabelsOnIssue: [ - "GET /repos/{owner}/{repo}/issues/{issue_number}/labels", - ], - listMilestones: ["GET /repos/{owner}/{repo}/milestones"], - lock: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"], - removeAllLabels: [ - "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels", - ], - removeAssignees: [ - "DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees", - ], - removeLabel: [ - "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - ], - setLabels: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"], - unlock: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"], - update: ["PATCH /repos/{owner}/{repo}/issues/{issue_number}"], - updateComment: ["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"], - updateLabel: ["PATCH /repos/{owner}/{repo}/labels/{name}"], - updateMilestone: [ - "PATCH /repos/{owner}/{repo}/milestones/{milestone_number}", - ], - }, - licenses: { - get: ["GET /licenses/{license}"], - getAllCommonlyUsed: ["GET /licenses"], - getForRepo: ["GET /repos/{owner}/{repo}/license"], - }, - markdown: { - render: ["POST /markdown"], - renderRaw: [ - "POST /markdown/raw", - { headers: { "content-type": "text/plain; charset=utf-8" } }, - ], - }, - meta: { - get: ["GET /meta"], - getOctocat: ["GET /octocat"], - getZen: ["GET /zen"], - root: ["GET /"], - }, - orgs: { - checkMembershipForUser: ["GET /orgs/{org}/members/{username}"], - checkPublicMembershipForUser: ["GET /orgs/{org}/public_members/{username}"], - convertMemberToOutsideCollaborator: [ - "PUT /orgs/{org}/outside_collaborators/{username}", - ], - createWebhook: ["POST /orgs/{org}/hooks"], - deleteWebhook: ["DELETE /orgs/{org}/hooks/{hook_id}"], - get: ["GET /orgs/{org}"], - getMembershipForAuthenticatedUser: ["GET /user/memberships/orgs/{org}"], - getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], - getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], - getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"], - getWebhookDelivery: [ - "GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}", - ], - list: ["GET /organizations"], - listAppInstallations: ["GET /orgs/{org}/installations"], - listForAuthenticatedUser: ["GET /user/orgs"], - listForUser: ["GET /users/{username}/orgs"], - listMembers: ["GET /orgs/{org}/members"], - listMembershipsForAuthenticatedUser: ["GET /user/memberships/orgs"], - listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], - listPublicMembers: ["GET /orgs/{org}/public_members"], - listWebhookDeliveries: ["GET /orgs/{org}/hooks/{hook_id}/deliveries"], - listWebhooks: ["GET /orgs/{org}/hooks"], - pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], - redeliverWebhookDelivery: [ - "POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - ], - removeMember: ["DELETE /orgs/{org}/members/{username}"], - removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"], - removeOutsideCollaborator: [ - "DELETE /orgs/{org}/outside_collaborators/{username}", - ], - removePublicMembershipForAuthenticatedUser: [ - "DELETE /orgs/{org}/public_members/{username}", - ], - setMembershipForUser: ["PUT /orgs/{org}/memberships/{username}"], - setPublicMembershipForAuthenticatedUser: [ - "PUT /orgs/{org}/public_members/{username}", - ], - update: ["PATCH /orgs/{org}"], - updateMembershipForAuthenticatedUser: [ - "PATCH /user/memberships/orgs/{org}", - ], - updateWebhook: ["PATCH /orgs/{org}/hooks/{hook_id}"], - updateWebhookConfigForOrg: ["PATCH /orgs/{org}/hooks/{hook_id}/config"], - }, - projects: { - addCollaborator: ["PUT /projects/{project_id}/collaborators/{username}"], - createCard: ["POST /projects/columns/{column_id}/cards"], - createColumn: ["POST /projects/{project_id}/columns"], - createForAuthenticatedUser: ["POST /user/projects"], - createForOrg: ["POST /orgs/{org}/projects"], - createForRepo: ["POST /repos/{owner}/{repo}/projects"], - delete: ["DELETE /projects/{project_id}"], - deleteCard: ["DELETE /projects/columns/cards/{card_id}"], - deleteColumn: ["DELETE /projects/columns/{column_id}"], - get: ["GET /projects/{project_id}"], - getCard: ["GET /projects/columns/cards/{card_id}"], - getColumn: ["GET /projects/columns/{column_id}"], - getPermissionForUser: [ - "GET /projects/{project_id}/collaborators/{username}/permission", - ], - listCards: ["GET /projects/columns/{column_id}/cards"], - listCollaborators: ["GET /projects/{project_id}/collaborators"], - listColumns: ["GET /projects/{project_id}/columns"], - listForOrg: ["GET /orgs/{org}/projects"], - listForRepo: ["GET /repos/{owner}/{repo}/projects"], - listForUser: ["GET /users/{username}/projects"], - moveCard: ["POST /projects/columns/cards/{card_id}/moves"], - moveColumn: ["POST /projects/columns/{column_id}/moves"], - removeCollaborator: [ - "DELETE /projects/{project_id}/collaborators/{username}", - ], - update: ["PATCH /projects/{project_id}"], - updateCard: ["PATCH /projects/columns/cards/{card_id}"], - updateColumn: ["PATCH /projects/columns/{column_id}"], - }, - pulls: { - checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], - create: ["POST /repos/{owner}/{repo}/pulls"], - createReplyForReviewComment: [ - "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - ], - createReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], - createReviewComment: [ - "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments", - ], - deletePendingReview: [ - "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - ], - deleteReviewComment: [ - "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}", - ], - dismissReview: [ - "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - ], - get: ["GET /repos/{owner}/{repo}/pulls/{pull_number}"], - getReview: [ - "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - ], - getReviewComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"], - list: ["GET /repos/{owner}/{repo}/pulls"], - listCommentsForReview: [ - "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - ], - listCommits: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"], - listFiles: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"], - listRequestedReviewers: [ - "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - ], - listReviewComments: [ - "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments", - ], - listReviewCommentsForRepo: ["GET /repos/{owner}/{repo}/pulls/comments"], - listReviews: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], - merge: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"], - removeRequestedReviewers: [ - "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - ], - requestReviewers: [ - "POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - ], - submitReview: [ - "POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - ], - update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"], - updateBranch: [ - "PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - ], - updateReview: [ - "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - ], - updateReviewComment: [ - "PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}", - ], - }, - rateLimit: { get: ["GET /rate_limit"] }, - reactions: { - createForCommitComment: [ - "POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", - ], - createForIssue: [ - "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", - ], - createForIssueComment: [ - "POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - ], - createForPullRequestReviewComment: [ - "POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - ], - createForRelease: [ - "POST /repos/{owner}/{repo}/releases/{release_id}/reactions", - ], - createForTeamDiscussionCommentInOrg: [ - "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - ], - createForTeamDiscussionCommentLegacy: [ - "POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - {}, - { - deprecated: - "octokit.scim.createForTeamDiscussionCommentLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment-legacy", - }, - ], - createForTeamDiscussionInOrg: [ - "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - ], - createForTeamDiscussionLegacy: [ - "POST /teams/{team_id}/discussions/{discussion_number}/reactions", - {}, - { - deprecated: - "octokit.scim.createForTeamDiscussionLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#create-reaction-for-a-team-discussion-legacy", - }, - ], - deleteForCommitComment: [ - "DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - ], - deleteForIssue: [ - "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - ], - deleteForIssueComment: [ - "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - ], - deleteForPullRequestComment: [ - "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - ], - deleteForRelease: [ - "DELETE /repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}", - ], - deleteForTeamDiscussion: [ - "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", - ], - deleteForTeamDiscussionComment: [ - "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", - ], - deleteLegacy: [ - "DELETE /reactions/{reaction_id}", - {}, - { - deprecated: - "octokit.scim.deleteLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#delete-a-reaction-legacy", - }, - ], - listForCommitComment: [ - "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", - ], - listForIssue: ["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"], - listForIssueComment: [ - "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - ], - listForPullRequestReviewComment: [ - "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - ], - listForRelease: [ - "GET /repos/{owner}/{repo}/releases/{release_id}/reactions", - ], - listForTeamDiscussionCommentInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - ], - listForTeamDiscussionCommentLegacy: [ - "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - {}, - { - deprecated: - "octokit.scim.listForTeamDiscussionCommentLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment-legacy", - }, - ], - listForTeamDiscussionInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - ], - listForTeamDiscussionLegacy: [ - "GET /teams/{team_id}/discussions/{discussion_number}/reactions", - {}, - { - deprecated: - "octokit.scim.listForTeamDiscussionLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/reactions/#list-reactions-for-a-team-discussion-legacy", - }, - ], - }, - repos: { - acceptInvitation: [ - "PATCH /user/repository_invitations/{invitation_id}", - {}, - { renamed: ["repos", "acceptInvitationForAuthenticatedUser"] }, - ], - acceptInvitationForAuthenticatedUser: [ - "PATCH /user/repository_invitations/{invitation_id}", - ], - addAppAccessRestrictions: [ - "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - ], - addCollaborator: ["PUT /repos/{owner}/{repo}/collaborators/{username}"], - addStatusCheckContexts: [ - "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - ], - addTeamAccessRestrictions: [ - "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - ], - addUserAccessRestrictions: [ - "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - ], - checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], - compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], - compareCommitsWithBasehead: [ - "GET /repos/{owner}/{repo}/compare/{basehead}", - ], - createCommitComment: [ - "POST /repos/{owner}/{repo}/commits/{commit_sha}/comments", - ], - createCommitSignatureProtection: [ - "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - ], - createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"], - createDeployKey: ["POST /repos/{owner}/{repo}/keys"], - createDeployment: ["POST /repos/{owner}/{repo}/deployments"], - createDeploymentBranchPolicy: [ - "POST /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - ], - createDeploymentStatus: [ - "POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - ], - createDispatchEvent: ["POST /repos/{owner}/{repo}/dispatches"], - createForAuthenticatedUser: ["POST /user/repos"], - createFork: ["POST /repos/{owner}/{repo}/forks"], - createInOrg: ["POST /orgs/{org}/repos"], - createOrUpdateEnvironment: [ - "PUT /repos/{owner}/{repo}/environments/{environment_name}", - ], - createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], - createPagesSite: ["POST /repos/{owner}/{repo}/pages"], - createRelease: ["POST /repos/{owner}/{repo}/releases"], - createUsingTemplate: [ - "POST /repos/{template_owner}/{template_repo}/generate", - ], - createWebhook: ["POST /repos/{owner}/{repo}/hooks"], - declineInvitation: [ - "DELETE /user/repository_invitations/{invitation_id}", - {}, - { renamed: ["repos", "declineInvitationForAuthenticatedUser"] }, - ], - declineInvitationForAuthenticatedUser: [ - "DELETE /user/repository_invitations/{invitation_id}", - ], - delete: ["DELETE /repos/{owner}/{repo}"], - deleteAccessRestrictions: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - ], - deleteAdminBranchProtection: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - ], - deleteAnEnvironment: [ - "DELETE /repos/{owner}/{repo}/environments/{environment_name}", - ], - deleteBranchProtection: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection", - ], - deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"], - deleteCommitSignatureProtection: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - ], - deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"], - deleteDeployment: [ - "DELETE /repos/{owner}/{repo}/deployments/{deployment_id}", - ], - deleteDeploymentBranchPolicy: [ - "DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - ], - deleteFile: ["DELETE /repos/{owner}/{repo}/contents/{path}"], - deleteInvitation: [ - "DELETE /repos/{owner}/{repo}/invitations/{invitation_id}", - ], - deletePagesSite: ["DELETE /repos/{owner}/{repo}/pages"], - deletePullRequestReviewProtection: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - ], - deleteRelease: ["DELETE /repos/{owner}/{repo}/releases/{release_id}"], - deleteReleaseAsset: [ - "DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}", - ], - deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], - downloadTarballArchive: ["GET /repos/{owner}/{repo}/tarball/{ref}"], - downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"], - get: ["GET /repos/{owner}/{repo}"], - getAccessRestrictions: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - ], - getAdminBranchProtection: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - ], - getAllEnvironments: ["GET /repos/{owner}/{repo}/environments"], - getAllStatusCheckContexts: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - ], - getAllTopics: ["GET /repos/{owner}/{repo}/topics"], - getAppsWithAccessToProtectedBranch: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - ], - getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"], - getBranchProtection: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection", - ], - getCodeFrequencyStats: ["GET /repos/{owner}/{repo}/stats/code_frequency"], - getCollaboratorPermissionLevel: [ - "GET /repos/{owner}/{repo}/collaborators/{username}/permission", - ], - getCombinedStatusForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/status"], - getCommit: ["GET /repos/{owner}/{repo}/commits/{ref}"], - getCommitActivityStats: ["GET /repos/{owner}/{repo}/stats/commit_activity"], - getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"], - getCommitSignatureProtection: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - ], - getContent: ["GET /repos/{owner}/{repo}/contents/{path}"], - getContributorsStats: ["GET /repos/{owner}/{repo}/stats/contributors"], - getDeployKey: ["GET /repos/{owner}/{repo}/keys/{key_id}"], - getDeployment: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}"], - getDeploymentBranchPolicy: [ - "GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - ], - getDeploymentStatus: [ - "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - ], - getEnvironment: [ - "GET /repos/{owner}/{repo}/environments/{environment_name}", - ], - getLatestPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/latest"], - getLatestRelease: ["GET /repos/{owner}/{repo}/releases/latest"], - getPages: ["GET /repos/{owner}/{repo}/pages"], - getPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/{build_id}"], - getParticipationStats: ["GET /repos/{owner}/{repo}/stats/participation"], - getPullRequestReviewProtection: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - ], - getPunchCardStats: ["GET /repos/{owner}/{repo}/stats/punch_card"], - getReadme: ["GET /repos/{owner}/{repo}/readme"], - getReadmeInDirectory: ["GET /repos/{owner}/{repo}/readme/{dir}"], - getRelease: ["GET /repos/{owner}/{repo}/releases/{release_id}"], - getReleaseAsset: ["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"], - getReleaseByTag: ["GET /repos/{owner}/{repo}/releases/tags/{tag}"], - getStatusChecksProtection: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - ], - getTeamsWithAccessToProtectedBranch: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - ], - getUsersWithAccessToProtectedBranch: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - ], - getWebhook: ["GET /repos/{owner}/{repo}/hooks/{hook_id}"], - getWebhookConfigForRepo: [ - "GET /repos/{owner}/{repo}/hooks/{hook_id}/config", - ], - getWebhookDelivery: [ - "GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}", - ], - listBranches: ["GET /repos/{owner}/{repo}/branches"], - listBranchesForHeadCommit: [ - "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - ], - listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"], - listCommentsForCommit: [ - "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments", - ], - listCommitCommentsForRepo: ["GET /repos/{owner}/{repo}/comments"], - listCommitStatusesForRef: [ - "GET /repos/{owner}/{repo}/commits/{ref}/statuses", - ], - listCommits: ["GET /repos/{owner}/{repo}/commits"], - listContributors: ["GET /repos/{owner}/{repo}/contributors"], - listDeployKeys: ["GET /repos/{owner}/{repo}/keys"], - listDeploymentBranchPolicies: [ - "GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - ], - listDeploymentStatuses: [ - "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - ], - listDeployments: ["GET /repos/{owner}/{repo}/deployments"], - listForAuthenticatedUser: ["GET /user/repos"], - listForOrg: ["GET /orgs/{org}/repos"], - listForUser: ["GET /users/{username}/repos"], - listForks: ["GET /repos/{owner}/{repo}/forks"], - listInvitations: ["GET /repos/{owner}/{repo}/invitations"], - listInvitationsForAuthenticatedUser: ["GET /user/repository_invitations"], - listLanguages: ["GET /repos/{owner}/{repo}/languages"], - listPagesBuilds: ["GET /repos/{owner}/{repo}/pages/builds"], - listPublic: ["GET /repositories"], - listPullRequestsAssociatedWithCommit: [ - "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", - ], - listReleaseAssets: [ - "GET /repos/{owner}/{repo}/releases/{release_id}/assets", - ], - listReleases: ["GET /repos/{owner}/{repo}/releases"], - listTags: ["GET /repos/{owner}/{repo}/tags"], - listTeams: ["GET /repos/{owner}/{repo}/teams"], - listWebhookDeliveries: [ - "GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries", - ], - listWebhooks: ["GET /repos/{owner}/{repo}/hooks"], - merge: ["POST /repos/{owner}/{repo}/merges"], - pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"], - redeliverWebhookDelivery: [ - "POST /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - ], - removeAppAccessRestrictions: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - ], - removeCollaborator: [ - "DELETE /repos/{owner}/{repo}/collaborators/{username}", - ], - removeStatusCheckContexts: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - ], - removeStatusCheckProtection: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - ], - removeTeamAccessRestrictions: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - ], - removeUserAccessRestrictions: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - ], - renameBranch: ["POST /repos/{owner}/{repo}/branches/{branch}/rename"], - replaceAllTopics: ["PUT /repos/{owner}/{repo}/topics"], - requestPagesBuild: ["POST /repos/{owner}/{repo}/pages/builds"], - setAdminBranchProtection: [ - "POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - ], - setAppAccessRestrictions: [ - "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - ], - setStatusCheckContexts: [ - "PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - ], - setTeamAccessRestrictions: [ - "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - ], - setUserAccessRestrictions: [ - "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - ], - testPushWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"], - transfer: ["POST /repos/{owner}/{repo}/transfer"], - update: ["PATCH /repos/{owner}/{repo}"], - updateBranchProtection: [ - "PUT /repos/{owner}/{repo}/branches/{branch}/protection", - ], - updateCommitComment: ["PATCH /repos/{owner}/{repo}/comments/{comment_id}"], - updateDeploymentBranchPolicy: [ - "PUT /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - ], - updateInformationAboutPagesSite: ["PUT /repos/{owner}/{repo}/pages"], - updateInvitation: [ - "PATCH /repos/{owner}/{repo}/invitations/{invitation_id}", - ], - updatePullRequestReviewProtection: [ - "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - ], - updateRelease: ["PATCH /repos/{owner}/{repo}/releases/{release_id}"], - updateReleaseAsset: [ - "PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}", - ], - updateStatusCheckProtection: [ - "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - ], - updateWebhook: ["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"], - updateWebhookConfigForRepo: [ - "PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config", - ], - uploadReleaseAsset: [ - "POST {origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", - ], - }, - search: { - code: ["GET /search/code"], - commits: ["GET /search/commits"], - issuesAndPullRequests: ["GET /search/issues"], - labels: ["GET /search/labels"], - repos: ["GET /search/repositories"], - topics: ["GET /search/topics"], - users: ["GET /search/users"], - }, - secretScanning: { - getAlert: [ - "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - ], - listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], - updateAlert: [ - "PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - ], - }, - teams: { - addMemberLegacy: [ - "PUT /teams/{team_id}/members/{username}", - {}, - { - deprecated: - "octokit.scim.addMemberLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#add-team-member-legacy", - }, - ], - addOrUpdateMembershipForUserInOrg: [ - "PUT /orgs/{org}/teams/{team_slug}/memberships/{username}", - ], - addOrUpdateMembershipForUserLegacy: [ - "PUT /teams/{team_id}/memberships/{username}", - {}, - { - deprecated: - "octokit.scim.addOrUpdateMembershipForUserLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy", - }, - ], - addOrUpdateProjectPermissionsInOrg: [ - "PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", - ], - addOrUpdateProjectPermissionsLegacy: [ - "PUT /teams/{team_id}/projects/{project_id}", - {}, - { - deprecated: - "octokit.scim.addOrUpdateProjectPermissionsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#add-or-update-team-project-permissions-legacy", - }, - ], - addOrUpdateRepoPermissionsInOrg: [ - "PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - ], - addOrUpdateRepoPermissionsLegacy: [ - "PUT /teams/{team_id}/repos/{owner}/{repo}", - {}, - { - deprecated: - "octokit.scim.addOrUpdateRepoPermissionsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#add-or-update-team-repository-permissions-legacy", - }, - ], - checkPermissionsForProjectInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", - ], - checkPermissionsForProjectLegacy: [ - "GET /teams/{team_id}/projects/{project_id}", - {}, - { - deprecated: - "octokit.scim.checkPermissionsForProjectLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#check-team-permissions-for-a-project-legacy", - }, - ], - checkPermissionsForRepoInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - ], - checkPermissionsForRepoLegacy: [ - "GET /teams/{team_id}/repos/{owner}/{repo}", - {}, - { - deprecated: - "octokit.scim.checkPermissionsForRepoLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#check-team-permissions-for-a-repository-legacy", - }, - ], - create: ["POST /orgs/{org}/teams"], - createDiscussionCommentInOrg: [ - "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - ], - createDiscussionCommentLegacy: [ - "POST /teams/{team_id}/discussions/{discussion_number}/comments", - {}, - { - deprecated: - "octokit.scim.createDiscussionCommentLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#create-a-discussion-comment-legacy", - }, - ], - createDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions"], - createDiscussionLegacy: [ - "POST /teams/{team_id}/discussions", - {}, - { - deprecated: - "octokit.scim.createDiscussionLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#create-a-discussion-legacy", - }, - ], - deleteDiscussionCommentInOrg: [ - "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - ], - deleteDiscussionCommentLegacy: [ - "DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - {}, - { - deprecated: - "octokit.scim.deleteDiscussionCommentLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#delete-a-discussion-comment-legacy", - }, - ], - deleteDiscussionInOrg: [ - "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - ], - deleteDiscussionLegacy: [ - "DELETE /teams/{team_id}/discussions/{discussion_number}", - {}, - { - deprecated: - "octokit.scim.deleteDiscussionLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#delete-a-discussion-legacy", - }, - ], - deleteInOrg: ["DELETE /orgs/{org}/teams/{team_slug}"], - deleteLegacy: [ - "DELETE /teams/{team_id}", - {}, - { - deprecated: - "octokit.scim.deleteLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#delete-a-team-legacy", - }, - ], - getByName: ["GET /orgs/{org}/teams/{team_slug}"], - getDiscussionCommentInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - ], - getDiscussionCommentLegacy: [ - "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - {}, - { - deprecated: - "octokit.scim.getDiscussionCommentLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-a-discussion-comment-legacy", - }, - ], - getDiscussionInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - ], - getDiscussionLegacy: [ - "GET /teams/{team_id}/discussions/{discussion_number}", - {}, - { - deprecated: - "octokit.scim.getDiscussionLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-a-discussion-legacy", - }, - ], - getLegacy: [ - "GET /teams/{team_id}", - {}, - { - deprecated: - "octokit.scim.getLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#get-a-team-legacy", - }, - ], - getMemberLegacy: [ - "GET /teams/{team_id}/members/{username}", - {}, - { - deprecated: - "octokit.scim.getMemberLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-team-member-legacy", - }, - ], - getMembershipForUserInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/memberships/{username}", - ], - getMembershipForUserLegacy: [ - "GET /teams/{team_id}/memberships/{username}", - {}, - { - deprecated: - "octokit.scim.getMembershipForUserLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#get-team-membership-for-a-user-legacy", - }, - ], - list: ["GET /orgs/{org}/teams"], - listChildInOrg: ["GET /orgs/{org}/teams/{team_slug}/teams"], - listChildLegacy: [ - "GET /teams/{team_id}/teams", - {}, - { - deprecated: - "octokit.scim.listChildLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#list-child-teams-legacy", - }, - ], - listDiscussionCommentsInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - ], - listDiscussionCommentsLegacy: [ - "GET /teams/{team_id}/discussions/{discussion_number}/comments", - {}, - { - deprecated: - "octokit.scim.listDiscussionCommentsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-discussion-comments-legacy", - }, - ], - listDiscussionsInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions"], - listDiscussionsLegacy: [ - "GET /teams/{team_id}/discussions", - {}, - { - deprecated: - "octokit.scim.listDiscussionsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-discussions-legacy", - }, - ], - listForAuthenticatedUser: ["GET /user/teams"], - listMembersInOrg: ["GET /orgs/{org}/teams/{team_slug}/members"], - listMembersLegacy: [ - "GET /teams/{team_id}/members", - {}, - { - deprecated: - "octokit.scim.listMembersLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#list-team-members-legacy", - }, - ], - listProjectsInOrg: ["GET /orgs/{org}/teams/{team_slug}/projects"], - listProjectsLegacy: [ - "GET /teams/{team_id}/projects", - {}, - { - deprecated: - "octokit.scim.listProjectsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#list-team-projects-legacy", - }, - ], - listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], - listReposLegacy: [ - "GET /teams/{team_id}/repos", - {}, - { - deprecated: - "octokit.scim.listReposLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#list-team-repositories-legacy", - }, - ], - removeMemberLegacy: [ - "DELETE /teams/{team_id}/members/{username}", - {}, - { - deprecated: - "octokit.scim.removeMemberLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#remove-team-member-legacy", - }, - ], - removeMembershipForUserInOrg: [ - "DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}", - ], - removeMembershipForUserLegacy: [ - "DELETE /teams/{team_id}/memberships/{username}", - {}, - { - deprecated: - "octokit.scim.removeMembershipForUserLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#remove-team-membership-for-a-user-legacy", - }, - ], - removeProjectInOrg: [ - "DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}", - ], - removeProjectLegacy: [ - "DELETE /teams/{team_id}/projects/{project_id}", - {}, - { - deprecated: - "octokit.scim.removeProjectLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#remove-a-project-from-a-team-legacy", - }, - ], - removeRepoInOrg: [ - "DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - ], - removeRepoLegacy: [ - "DELETE /teams/{team_id}/repos/{owner}/{repo}", - {}, - { - deprecated: - "octokit.scim.removeRepoLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#remove-a-repository-from-a-team-legacy", - }, - ], - updateDiscussionCommentInOrg: [ - "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - ], - updateDiscussionCommentLegacy: [ - "PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - {}, - { - deprecated: - "octokit.scim.updateDiscussionCommentLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#update-a-discussion-comment-legacy", - }, - ], - updateDiscussionInOrg: [ - "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - ], - updateDiscussionLegacy: [ - "PATCH /teams/{team_id}/discussions/{discussion_number}", - {}, - { - deprecated: - "octokit.scim.updateDiscussionLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams#update-a-discussion-legacy", - }, - ], - updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"], - updateLegacy: [ - "PATCH /teams/{team_id}", - {}, - { - deprecated: - "octokit.scim.updateLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.2/rest/reference/teams/#update-a-team-legacy", - }, - ], - }, - users: { - addEmailForAuthenticated: [ - "POST /user/emails", - {}, - { renamed: ["users", "addEmailForAuthenticatedUser"] }, - ], - addEmailForAuthenticatedUser: ["POST /user/emails"], - checkFollowingForUser: ["GET /users/{username}/following/{target_user}"], - checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"], - createGpgKeyForAuthenticated: [ - "POST /user/gpg_keys", - {}, - { renamed: ["users", "createGpgKeyForAuthenticatedUser"] }, - ], - createGpgKeyForAuthenticatedUser: ["POST /user/gpg_keys"], - createPublicSshKeyForAuthenticated: [ - "POST /user/keys", - {}, - { renamed: ["users", "createPublicSshKeyForAuthenticatedUser"] }, - ], - createPublicSshKeyForAuthenticatedUser: ["POST /user/keys"], - deleteEmailForAuthenticated: [ - "DELETE /user/emails", - {}, - { renamed: ["users", "deleteEmailForAuthenticatedUser"] }, - ], - deleteEmailForAuthenticatedUser: ["DELETE /user/emails"], - deleteGpgKeyForAuthenticated: [ - "DELETE /user/gpg_keys/{gpg_key_id}", - {}, - { renamed: ["users", "deleteGpgKeyForAuthenticatedUser"] }, - ], - deleteGpgKeyForAuthenticatedUser: ["DELETE /user/gpg_keys/{gpg_key_id}"], - deletePublicSshKeyForAuthenticated: [ - "DELETE /user/keys/{key_id}", - {}, - { renamed: ["users", "deletePublicSshKeyForAuthenticatedUser"] }, - ], - deletePublicSshKeyForAuthenticatedUser: ["DELETE /user/keys/{key_id}"], - follow: ["PUT /user/following/{username}"], - getAuthenticated: ["GET /user"], - getByUsername: ["GET /users/{username}"], - getContextForUser: ["GET /users/{username}/hovercard"], - getGpgKeyForAuthenticated: [ - "GET /user/gpg_keys/{gpg_key_id}", - {}, - { renamed: ["users", "getGpgKeyForAuthenticatedUser"] }, - ], - getGpgKeyForAuthenticatedUser: ["GET /user/gpg_keys/{gpg_key_id}"], - getPublicSshKeyForAuthenticated: [ - "GET /user/keys/{key_id}", - {}, - { renamed: ["users", "getPublicSshKeyForAuthenticatedUser"] }, - ], - getPublicSshKeyForAuthenticatedUser: ["GET /user/keys/{key_id}"], - list: ["GET /users"], - listEmailsForAuthenticated: [ - "GET /user/emails", - {}, - { renamed: ["users", "listEmailsForAuthenticatedUser"] }, - ], - listEmailsForAuthenticatedUser: ["GET /user/emails"], - listFollowedByAuthenticated: [ - "GET /user/following", - {}, - { renamed: ["users", "listFollowedByAuthenticatedUser"] }, - ], - listFollowedByAuthenticatedUser: ["GET /user/following"], - listFollowersForAuthenticatedUser: ["GET /user/followers"], - listFollowersForUser: ["GET /users/{username}/followers"], - listFollowingForUser: ["GET /users/{username}/following"], - listGpgKeysForAuthenticated: [ - "GET /user/gpg_keys", - {}, - { renamed: ["users", "listGpgKeysForAuthenticatedUser"] }, - ], - listGpgKeysForAuthenticatedUser: ["GET /user/gpg_keys"], - listGpgKeysForUser: ["GET /users/{username}/gpg_keys"], - listPublicEmailsForAuthenticated: [ - "GET /user/public_emails", - {}, - { renamed: ["users", "listPublicEmailsForAuthenticatedUser"] }, - ], - listPublicEmailsForAuthenticatedUser: ["GET /user/public_emails"], - listPublicKeysForUser: ["GET /users/{username}/keys"], - listPublicSshKeysForAuthenticated: [ - "GET /user/keys", - {}, - { renamed: ["users", "listPublicSshKeysForAuthenticatedUser"] }, - ], - listPublicSshKeysForAuthenticatedUser: ["GET /user/keys"], - unfollow: ["DELETE /user/following/{username}"], - updateAuthenticated: ["PATCH /user"], - }, -}; - -export default Endpoints; diff --git a/src/generated/ghe-33-admin-endpoints.ts b/src/generated/ghe-33-admin-endpoints.ts deleted file mode 100644 index c3a6e044..00000000 --- a/src/generated/ghe-33-admin-endpoints.ts +++ /dev/null @@ -1,136 +0,0 @@ -import { EndpointsDefaultsAndDecorations } from "../types"; -const Endpoints: EndpointsDefaultsAndDecorations = { - enterpriseAdmin: { - addAuthorizedSshKey: ["POST {origin}/setup/api/settings/authorized-keys"], - createEnterpriseServerLicense: ["POST {origin}/setup/api/start"], - createGlobalWebhook: ["POST /admin/hooks"], - createImpersonationOAuthToken: [ - "POST /admin/users/{username}/authorizations", - ], - createOrg: ["POST /admin/organizations"], - createPreReceiveEnvironment: ["POST /admin/pre-receive-environments"], - createPreReceiveHook: ["POST /admin/pre-receive-hooks"], - createUser: ["POST /admin/users"], - deleteGlobalWebhook: ["DELETE /admin/hooks/{hook_id}"], - deleteImpersonationOAuthToken: [ - "DELETE /admin/users/{username}/authorizations", - ], - deletePersonalAccessToken: ["DELETE /admin/tokens/{token_id}"], - deletePreReceiveEnvironment: [ - "DELETE /admin/pre-receive-environments/{pre_receive_environment_id}", - ], - deletePreReceiveHook: [ - "DELETE /admin/pre-receive-hooks/{pre_receive_hook_id}", - ], - deletePublicKey: ["DELETE /admin/keys/{key_ids}"], - deleteUser: ["DELETE /admin/users/{username}"], - demoteSiteAdministrator: ["DELETE /users/{username}/site_admin"], - disableSelectedOrganizationGithubActionsEnterprise: [ - "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - ], - enableOrDisableMaintenanceMode: ["POST {origin}/setup/api/maintenance"], - enableSelectedOrganizationGithubActionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - ], - getAllAuthorizedSshKeys: [ - "GET {origin}/setup/api/settings/authorized-keys", - ], - getAllStats: ["GET /enterprise/stats/all"], - getAllowedActionsEnterprise: [ - "GET /enterprises/{enterprise}/actions/permissions/selected-actions", - ], - getAnnouncement: ["GET /enterprise/announcement"], - getCommentStats: ["GET /enterprise/stats/comments"], - getConfigurationStatus: ["GET {origin}/setup/api/configcheck"], - getDownloadStatusForPreReceiveEnvironment: [ - "GET /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - ], - getGistStats: ["GET /enterprise/stats/gists"], - getGithubActionsPermissionsEnterprise: [ - "GET /enterprises/{enterprise}/actions/permissions", - ], - getGlobalWebhook: ["GET /admin/hooks/{hook_id}"], - getHooksStats: ["GET /enterprise/stats/hooks"], - getIssueStats: ["GET /enterprise/stats/issues"], - getLicenseInformation: ["GET /enterprise/settings/license"], - getMaintenanceStatus: ["GET {origin}/setup/api/maintenance"], - getMilestoneStats: ["GET /enterprise/stats/milestones"], - getOrgStats: ["GET /enterprise/stats/orgs"], - getPagesStats: ["GET /enterprise/stats/pages"], - getPreReceiveEnvironment: [ - "GET /admin/pre-receive-environments/{pre_receive_environment_id}", - ], - getPreReceiveHook: ["GET /admin/pre-receive-hooks/{pre_receive_hook_id}"], - getPreReceiveHookForOrg: [ - "GET /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - ], - getPreReceiveHookForRepo: [ - "GET /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - ], - getPullRequestStats: ["GET /enterprise/stats/pulls"], - getRepoStats: ["GET /enterprise/stats/repos"], - getSettings: ["GET {origin}/setup/api/settings"], - getUserStats: ["GET /enterprise/stats/users"], - listGlobalWebhooks: ["GET /admin/hooks"], - listPersonalAccessTokens: ["GET /admin/tokens"], - listPreReceiveEnvironments: ["GET /admin/pre-receive-environments"], - listPreReceiveHooks: ["GET /admin/pre-receive-hooks"], - listPreReceiveHooksForOrg: ["GET /orgs/{org}/pre-receive-hooks"], - listPreReceiveHooksForRepo: ["GET /repos/{owner}/{repo}/pre-receive-hooks"], - listPublicKeys: ["GET /admin/keys"], - listSelectedOrganizationsEnabledGithubActionsEnterprise: [ - "GET /enterprises/{enterprise}/actions/permissions/organizations", - ], - pingGlobalWebhook: ["POST /admin/hooks/{hook_id}/pings"], - promoteUserToBeSiteAdministrator: ["PUT /users/{username}/site_admin"], - removeAnnouncement: ["DELETE /enterprise/announcement"], - removeAuthorizedSshKey: [ - "DELETE {origin}/setup/api/settings/authorized-keys", - ], - removePreReceiveHookEnforcementForOrg: [ - "DELETE /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - ], - removePreReceiveHookEnforcementForRepo: [ - "DELETE /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - ], - setAllowedActionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions/selected-actions", - ], - setAnnouncement: ["PATCH /enterprise/announcement"], - setGithubActionsPermissionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions", - ], - setSelectedOrganizationsEnabledGithubActionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions/organizations", - ], - setSettings: ["PUT {origin}/setup/api/settings"], - startConfigurationProcess: ["POST {origin}/setup/api/configure"], - startPreReceiveEnvironmentDownload: [ - "POST /admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - ], - suspendUser: ["PUT /users/{username}/suspended"], - syncLdapMappingForTeam: ["POST /admin/ldap/teams/{team_id}/sync"], - syncLdapMappingForUser: ["POST /admin/ldap/users/{username}/sync"], - unsuspendUser: ["DELETE /users/{username}/suspended"], - updateGlobalWebhook: ["PATCH /admin/hooks/{hook_id}"], - updateLdapMappingForTeam: ["PATCH /admin/ldap/teams/{team_id}/mapping"], - updateLdapMappingForUser: ["PATCH /admin/ldap/users/{username}/mapping"], - updateOrgName: ["PATCH /admin/organizations/{org}"], - updatePreReceiveEnvironment: [ - "PATCH /admin/pre-receive-environments/{pre_receive_environment_id}", - ], - updatePreReceiveHook: [ - "PATCH /admin/pre-receive-hooks/{pre_receive_hook_id}", - ], - updatePreReceiveHookEnforcementForOrg: [ - "PATCH /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - ], - updatePreReceiveHookEnforcementForRepo: [ - "PATCH /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - ], - updateUsernameForUser: ["PATCH /admin/users/{username}"], - upgradeLicense: ["POST {origin}/setup/api/upgrade"], - }, -}; - -export default Endpoints; diff --git a/src/generated/ghe-33-endpoints.ts b/src/generated/ghe-33-endpoints.ts deleted file mode 100644 index 2b3c5793..00000000 --- a/src/generated/ghe-33-endpoints.ts +++ /dev/null @@ -1,1573 +0,0 @@ -import { EndpointsDefaultsAndDecorations } from "../types"; -const Endpoints: EndpointsDefaultsAndDecorations = { - actions: { - addSelectedRepoToOrgSecret: [ - "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - ], - cancelWorkflowRun: [ - "POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel", - ], - createOrUpdateEnvironmentSecret: [ - "PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", - ], - createOrUpdateOrgSecret: ["PUT /orgs/{org}/actions/secrets/{secret_name}"], - createOrUpdateRepoSecret: [ - "PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}", - ], - createRegistrationTokenForOrg: [ - "POST /orgs/{org}/actions/runners/registration-token", - ], - createRegistrationTokenForRepo: [ - "POST /repos/{owner}/{repo}/actions/runners/registration-token", - ], - createRemoveTokenForOrg: ["POST /orgs/{org}/actions/runners/remove-token"], - createRemoveTokenForRepo: [ - "POST /repos/{owner}/{repo}/actions/runners/remove-token", - ], - createWorkflowDispatch: [ - "POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", - ], - deleteArtifact: [ - "DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - ], - deleteEnvironmentSecret: [ - "DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", - ], - deleteOrgSecret: ["DELETE /orgs/{org}/actions/secrets/{secret_name}"], - deleteRepoSecret: [ - "DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}", - ], - deleteSelfHostedRunnerFromOrg: [ - "DELETE /orgs/{org}/actions/runners/{runner_id}", - ], - deleteSelfHostedRunnerFromRepo: [ - "DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}", - ], - deleteWorkflowRun: ["DELETE /repos/{owner}/{repo}/actions/runs/{run_id}"], - deleteWorkflowRunLogs: [ - "DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs", - ], - disableSelectedRepositoryGithubActionsOrganization: [ - "DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}", - ], - disableWorkflow: [ - "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", - ], - downloadArtifact: [ - "GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", - ], - downloadJobLogsForWorkflowRun: [ - "GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs", - ], - downloadWorkflowRunLogs: [ - "GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs", - ], - enableSelectedRepositoryGithubActionsOrganization: [ - "PUT /orgs/{org}/actions/permissions/repositories/{repository_id}", - ], - enableWorkflow: [ - "PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", - ], - getAllowedActionsOrganization: [ - "GET /orgs/{org}/actions/permissions/selected-actions", - ], - getAllowedActionsRepository: [ - "GET /repos/{owner}/{repo}/actions/permissions/selected-actions", - ], - getArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"], - getEnvironmentPublicKey: [ - "GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key", - ], - getEnvironmentSecret: [ - "GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", - ], - getGithubActionsPermissionsOrganization: [ - "GET /orgs/{org}/actions/permissions", - ], - getGithubActionsPermissionsRepository: [ - "GET /repos/{owner}/{repo}/actions/permissions", - ], - getJobForWorkflowRun: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"], - getOrgPublicKey: ["GET /orgs/{org}/actions/secrets/public-key"], - getOrgSecret: ["GET /orgs/{org}/actions/secrets/{secret_name}"], - getPendingDeploymentsForRun: [ - "GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - ], - getRepoPublicKey: ["GET /repos/{owner}/{repo}/actions/secrets/public-key"], - getRepoSecret: ["GET /repos/{owner}/{repo}/actions/secrets/{secret_name}"], - getReviewsForRun: [ - "GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals", - ], - getSelfHostedRunnerForOrg: ["GET /orgs/{org}/actions/runners/{runner_id}"], - getSelfHostedRunnerForRepo: [ - "GET /repos/{owner}/{repo}/actions/runners/{runner_id}", - ], - getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], - getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], - listArtifactsForRepo: ["GET /repos/{owner}/{repo}/actions/artifacts"], - listEnvironmentSecrets: [ - "GET /repositories/{repository_id}/environments/{environment_name}/secrets", - ], - listJobsForWorkflowRun: [ - "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs", - ], - listOrgSecrets: ["GET /orgs/{org}/actions/secrets"], - listRepoSecrets: ["GET /repos/{owner}/{repo}/actions/secrets"], - listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], - listRunnerApplicationsForOrg: ["GET /orgs/{org}/actions/runners/downloads"], - listRunnerApplicationsForRepo: [ - "GET /repos/{owner}/{repo}/actions/runners/downloads", - ], - listSelectedReposForOrgSecret: [ - "GET /orgs/{org}/actions/secrets/{secret_name}/repositories", - ], - listSelectedRepositoriesEnabledGithubActionsOrganization: [ - "GET /orgs/{org}/actions/permissions/repositories", - ], - listSelfHostedRunnersForOrg: ["GET /orgs/{org}/actions/runners"], - listSelfHostedRunnersForRepo: ["GET /repos/{owner}/{repo}/actions/runners"], - listWorkflowRunArtifacts: [ - "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", - ], - listWorkflowRuns: [ - "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", - ], - listWorkflowRunsForRepo: ["GET /repos/{owner}/{repo}/actions/runs"], - reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"], - removeSelectedRepoFromOrgSecret: [ - "DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", - ], - reviewPendingDeploymentsForRun: [ - "POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", - ], - setAllowedActionsOrganization: [ - "PUT /orgs/{org}/actions/permissions/selected-actions", - ], - setAllowedActionsRepository: [ - "PUT /repos/{owner}/{repo}/actions/permissions/selected-actions", - ], - setGithubActionsPermissionsOrganization: [ - "PUT /orgs/{org}/actions/permissions", - ], - setGithubActionsPermissionsRepository: [ - "PUT /repos/{owner}/{repo}/actions/permissions", - ], - setSelectedReposForOrgSecret: [ - "PUT /orgs/{org}/actions/secrets/{secret_name}/repositories", - ], - setSelectedRepositoriesEnabledGithubActionsOrganization: [ - "PUT /orgs/{org}/actions/permissions/repositories", - ], - }, - activity: { - checkRepoIsStarredByAuthenticatedUser: ["GET /user/starred/{owner}/{repo}"], - deleteRepoSubscription: ["DELETE /repos/{owner}/{repo}/subscription"], - deleteThreadSubscription: [ - "DELETE /notifications/threads/{thread_id}/subscription", - ], - getFeeds: ["GET /feeds"], - getRepoSubscription: ["GET /repos/{owner}/{repo}/subscription"], - getThread: ["GET /notifications/threads/{thread_id}"], - getThreadSubscriptionForAuthenticatedUser: [ - "GET /notifications/threads/{thread_id}/subscription", - ], - listEventsForAuthenticatedUser: ["GET /users/{username}/events"], - listNotificationsForAuthenticatedUser: ["GET /notifications"], - listOrgEventsForAuthenticatedUser: [ - "GET /users/{username}/events/orgs/{org}", - ], - listPublicEvents: ["GET /events"], - listPublicEventsForRepoNetwork: ["GET /networks/{owner}/{repo}/events"], - listPublicEventsForUser: ["GET /users/{username}/events/public"], - listPublicOrgEvents: ["GET /orgs/{org}/events"], - listReceivedEventsForUser: ["GET /users/{username}/received_events"], - listReceivedPublicEventsForUser: [ - "GET /users/{username}/received_events/public", - ], - listRepoEvents: ["GET /repos/{owner}/{repo}/events"], - listRepoNotificationsForAuthenticatedUser: [ - "GET /repos/{owner}/{repo}/notifications", - ], - listReposStarredByAuthenticatedUser: ["GET /user/starred"], - listReposStarredByUser: ["GET /users/{username}/starred"], - listReposWatchedByUser: ["GET /users/{username}/subscriptions"], - listStargazersForRepo: ["GET /repos/{owner}/{repo}/stargazers"], - listWatchedReposForAuthenticatedUser: ["GET /user/subscriptions"], - listWatchersForRepo: ["GET /repos/{owner}/{repo}/subscribers"], - markNotificationsAsRead: ["PUT /notifications"], - markRepoNotificationsAsRead: ["PUT /repos/{owner}/{repo}/notifications"], - markThreadAsRead: ["PATCH /notifications/threads/{thread_id}"], - setRepoSubscription: ["PUT /repos/{owner}/{repo}/subscription"], - setThreadSubscription: [ - "PUT /notifications/threads/{thread_id}/subscription", - ], - starRepoForAuthenticatedUser: ["PUT /user/starred/{owner}/{repo}"], - unstarRepoForAuthenticatedUser: ["DELETE /user/starred/{owner}/{repo}"], - }, - apps: { - addRepoToInstallation: [ - "PUT /user/installations/{installation_id}/repositories/{repository_id}", - {}, - { renamed: ["apps", "addRepoToInstallationForAuthenticatedUser"] }, - ], - addRepoToInstallationForAuthenticatedUser: [ - "PUT /user/installations/{installation_id}/repositories/{repository_id}", - ], - checkAuthorization: [ - "GET /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.checkAuthorization() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#check-an-authorization", - }, - ], - checkToken: ["POST /applications/{client_id}/token"], - createContentAttachment: [ - "POST /content_references/{content_reference_id}/attachments", - { mediaType: { previews: ["corsair"] } }, - ], - createContentAttachmentForRepo: [ - "POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", - ], - createFromManifest: ["POST /app-manifests/{code}/conversions"], - createInstallationAccessToken: [ - "POST /app/installations/{installation_id}/access_tokens", - ], - deleteAuthorization: ["DELETE /applications/{client_id}/grant"], - deleteInstallation: ["DELETE /app/installations/{installation_id}"], - deleteToken: ["DELETE /applications/{client_id}/token"], - getAuthenticated: ["GET /app"], - getBySlug: ["GET /apps/{app_slug}"], - getInstallation: ["GET /app/installations/{installation_id}"], - getOrgInstallation: ["GET /orgs/{org}/installation"], - getRepoInstallation: ["GET /repos/{owner}/{repo}/installation"], - getUserInstallation: ["GET /users/{username}/installation"], - getWebhookConfigForApp: ["GET /app/hook/config"], - getWebhookDelivery: ["GET /app/hook/deliveries/{delivery_id}"], - listInstallationReposForAuthenticatedUser: [ - "GET /user/installations/{installation_id}/repositories", - ], - listInstallations: ["GET /app/installations"], - listInstallationsForAuthenticatedUser: ["GET /user/installations"], - listReposAccessibleToInstallation: ["GET /installation/repositories"], - listWebhookDeliveries: ["GET /app/hook/deliveries"], - redeliverWebhookDelivery: [ - "POST /app/hook/deliveries/{delivery_id}/attempts", - ], - removeRepoFromInstallation: [ - "DELETE /user/installations/{installation_id}/repositories/{repository_id}", - {}, - { renamed: ["apps", "removeRepoFromInstallationForAuthenticatedUser"] }, - ], - removeRepoFromInstallationForAuthenticatedUser: [ - "DELETE /user/installations/{installation_id}/repositories/{repository_id}", - ], - resetAuthorization: [ - "POST /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.resetAuthorization() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#reset-an-authorization", - }, - ], - resetToken: ["PATCH /applications/{client_id}/token"], - revokeAuthorizationForApplication: [ - "DELETE /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.revokeAuthorizationForApplication() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-an-authorization-for-an-application", - }, - ], - revokeGrantForApplication: [ - "DELETE /applications/{client_id}/grants/{access_token}", - {}, - { - deprecated: - "octokit.scim.revokeGrantForApplication() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-a-grant-for-an-application", - }, - ], - revokeInstallationAccessToken: ["DELETE /installation/token"], - scopeToken: ["POST /applications/{client_id}/token/scoped"], - suspendInstallation: ["PUT /app/installations/{installation_id}/suspended"], - unsuspendInstallation: [ - "DELETE /app/installations/{installation_id}/suspended", - ], - updateWebhookConfigForApp: ["PATCH /app/hook/config"], - }, - checks: { - create: ["POST /repos/{owner}/{repo}/check-runs"], - createSuite: ["POST /repos/{owner}/{repo}/check-suites"], - get: ["GET /repos/{owner}/{repo}/check-runs/{check_run_id}"], - getSuite: ["GET /repos/{owner}/{repo}/check-suites/{check_suite_id}"], - listAnnotations: [ - "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", - ], - listForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-runs"], - listForSuite: [ - "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", - ], - listSuitesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/check-suites"], - rerequestRun: [ - "POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest", - ], - rerequestSuite: [ - "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", - ], - setSuitesPreferences: [ - "PATCH /repos/{owner}/{repo}/check-suites/preferences", - ], - update: ["PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}"], - }, - codeScanning: { - deleteAnalysis: [ - "DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}{?confirm_delete}", - ], - getAlert: ["GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}"], - getAnalysis: [ - "GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", - ], - getSarif: ["GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}"], - listAlertInstances: [ - "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", - ], - listAlertsForRepo: ["GET /repos/{owner}/{repo}/code-scanning/alerts"], - listAlertsInstances: [ - "GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", - {}, - { renamed: ["codeScanning", "listAlertInstances"] }, - ], - listRecentAnalyses: ["GET /repos/{owner}/{repo}/code-scanning/analyses"], - updateAlert: [ - "PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", - ], - uploadSarif: ["POST /repos/{owner}/{repo}/code-scanning/sarifs"], - }, - codesOfConduct: { - getAllCodesOfConduct: ["GET /codes_of_conduct"], - getConductCode: ["GET /codes_of_conduct/{key}"], - getForRepo: [ - "GET /repos/{owner}/{repo}/community/code_of_conduct", - { mediaType: { previews: ["scarlet-witch"] } }, - { - deprecated: - "octokit.scim.getForRepo() is deprecated, see https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository", - }, - ], - }, - emojis: { get: ["GET /emojis"] }, - enterpriseAdmin: { - addAuthorizedSshKey: ["POST {origin}/setup/api/settings/authorized-keys"], - createEnterpriseServerLicense: ["POST {origin}/setup/api/start"], - createGlobalWebhook: ["POST /admin/hooks"], - createImpersonationOAuthToken: [ - "POST /admin/users/{username}/authorizations", - ], - createOrg: ["POST /admin/organizations"], - createPreReceiveEnvironment: ["POST /admin/pre-receive-environments"], - createPreReceiveHook: ["POST /admin/pre-receive-hooks"], - createUser: ["POST /admin/users"], - deleteGlobalWebhook: ["DELETE /admin/hooks/{hook_id}"], - deleteImpersonationOAuthToken: [ - "DELETE /admin/users/{username}/authorizations", - ], - deletePersonalAccessToken: ["DELETE /admin/tokens/{token_id}"], - deletePreReceiveEnvironment: [ - "DELETE /admin/pre-receive-environments/{pre_receive_environment_id}", - ], - deletePreReceiveHook: [ - "DELETE /admin/pre-receive-hooks/{pre_receive_hook_id}", - ], - deletePublicKey: ["DELETE /admin/keys/{key_ids}"], - deleteUser: ["DELETE /admin/users/{username}"], - demoteSiteAdministrator: ["DELETE /users/{username}/site_admin"], - disableSelectedOrganizationGithubActionsEnterprise: [ - "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - ], - enableOrDisableMaintenanceMode: ["POST {origin}/setup/api/maintenance"], - enableSelectedOrganizationGithubActionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", - ], - getAllAuthorizedSshKeys: [ - "GET {origin}/setup/api/settings/authorized-keys", - ], - getAllStats: ["GET /enterprise/stats/all"], - getAllowedActionsEnterprise: [ - "GET /enterprises/{enterprise}/actions/permissions/selected-actions", - ], - getAnnouncement: ["GET /enterprise/announcement"], - getCommentStats: ["GET /enterprise/stats/comments"], - getConfigurationStatus: ["GET {origin}/setup/api/configcheck"], - getDownloadStatusForPreReceiveEnvironment: [ - "GET /admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest", - ], - getGistStats: ["GET /enterprise/stats/gists"], - getGithubActionsPermissionsEnterprise: [ - "GET /enterprises/{enterprise}/actions/permissions", - ], - getGlobalWebhook: ["GET /admin/hooks/{hook_id}"], - getHooksStats: ["GET /enterprise/stats/hooks"], - getIssueStats: ["GET /enterprise/stats/issues"], - getLicenseInformation: ["GET /enterprise/settings/license"], - getMaintenanceStatus: ["GET {origin}/setup/api/maintenance"], - getMilestoneStats: ["GET /enterprise/stats/milestones"], - getOrgStats: ["GET /enterprise/stats/orgs"], - getPagesStats: ["GET /enterprise/stats/pages"], - getPreReceiveEnvironment: [ - "GET /admin/pre-receive-environments/{pre_receive_environment_id}", - ], - getPreReceiveHook: ["GET /admin/pre-receive-hooks/{pre_receive_hook_id}"], - getPreReceiveHookForOrg: [ - "GET /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - ], - getPreReceiveHookForRepo: [ - "GET /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - ], - getPullRequestStats: ["GET /enterprise/stats/pulls"], - getRepoStats: ["GET /enterprise/stats/repos"], - getSettings: ["GET {origin}/setup/api/settings"], - getUserStats: ["GET /enterprise/stats/users"], - listGlobalWebhooks: ["GET /admin/hooks"], - listPersonalAccessTokens: ["GET /admin/tokens"], - listPreReceiveEnvironments: ["GET /admin/pre-receive-environments"], - listPreReceiveHooks: ["GET /admin/pre-receive-hooks"], - listPreReceiveHooksForOrg: ["GET /orgs/{org}/pre-receive-hooks"], - listPreReceiveHooksForRepo: ["GET /repos/{owner}/{repo}/pre-receive-hooks"], - listPublicKeys: ["GET /admin/keys"], - listSelectedOrganizationsEnabledGithubActionsEnterprise: [ - "GET /enterprises/{enterprise}/actions/permissions/organizations", - ], - pingGlobalWebhook: ["POST /admin/hooks/{hook_id}/pings"], - promoteUserToBeSiteAdministrator: ["PUT /users/{username}/site_admin"], - removeAnnouncement: ["DELETE /enterprise/announcement"], - removeAuthorizedSshKey: [ - "DELETE {origin}/setup/api/settings/authorized-keys", - ], - removePreReceiveHookEnforcementForOrg: [ - "DELETE /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - ], - removePreReceiveHookEnforcementForRepo: [ - "DELETE /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - ], - setAllowedActionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions/selected-actions", - ], - setAnnouncement: ["PATCH /enterprise/announcement"], - setGithubActionsPermissionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions", - ], - setSelectedOrganizationsEnabledGithubActionsEnterprise: [ - "PUT /enterprises/{enterprise}/actions/permissions/organizations", - ], - setSettings: ["PUT {origin}/setup/api/settings"], - startConfigurationProcess: ["POST {origin}/setup/api/configure"], - startPreReceiveEnvironmentDownload: [ - "POST /admin/pre-receive-environments/{pre_receive_environment_id}/downloads", - ], - suspendUser: ["PUT /users/{username}/suspended"], - syncLdapMappingForTeam: ["POST /admin/ldap/teams/{team_id}/sync"], - syncLdapMappingForUser: ["POST /admin/ldap/users/{username}/sync"], - unsuspendUser: ["DELETE /users/{username}/suspended"], - updateGlobalWebhook: ["PATCH /admin/hooks/{hook_id}"], - updateLdapMappingForTeam: ["PATCH /admin/ldap/teams/{team_id}/mapping"], - updateLdapMappingForUser: ["PATCH /admin/ldap/users/{username}/mapping"], - updateOrgName: ["PATCH /admin/organizations/{org}"], - updatePreReceiveEnvironment: [ - "PATCH /admin/pre-receive-environments/{pre_receive_environment_id}", - ], - updatePreReceiveHook: [ - "PATCH /admin/pre-receive-hooks/{pre_receive_hook_id}", - ], - updatePreReceiveHookEnforcementForOrg: [ - "PATCH /orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}", - ], - updatePreReceiveHookEnforcementForRepo: [ - "PATCH /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", - ], - updateUsernameForUser: ["PATCH /admin/users/{username}"], - upgradeLicense: ["POST {origin}/setup/api/upgrade"], - }, - gists: { - checkIsStarred: ["GET /gists/{gist_id}/star"], - create: ["POST /gists"], - createComment: ["POST /gists/{gist_id}/comments"], - delete: ["DELETE /gists/{gist_id}"], - deleteComment: ["DELETE /gists/{gist_id}/comments/{comment_id}"], - fork: ["POST /gists/{gist_id}/forks"], - get: ["GET /gists/{gist_id}"], - getComment: ["GET /gists/{gist_id}/comments/{comment_id}"], - getRevision: ["GET /gists/{gist_id}/{sha}"], - list: ["GET /gists"], - listComments: ["GET /gists/{gist_id}/comments"], - listCommits: ["GET /gists/{gist_id}/commits"], - listForUser: ["GET /users/{username}/gists"], - listForks: ["GET /gists/{gist_id}/forks"], - listPublic: ["GET /gists/public"], - listStarred: ["GET /gists/starred"], - star: ["PUT /gists/{gist_id}/star"], - unstar: ["DELETE /gists/{gist_id}/star"], - update: ["PATCH /gists/{gist_id}"], - updateComment: ["PATCH /gists/{gist_id}/comments/{comment_id}"], - }, - git: { - createBlob: ["POST /repos/{owner}/{repo}/git/blobs"], - createCommit: ["POST /repos/{owner}/{repo}/git/commits"], - createRef: ["POST /repos/{owner}/{repo}/git/refs"], - createTag: ["POST /repos/{owner}/{repo}/git/tags"], - createTree: ["POST /repos/{owner}/{repo}/git/trees"], - deleteRef: ["DELETE /repos/{owner}/{repo}/git/refs/{ref}"], - getBlob: ["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"], - getCommit: ["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"], - getRef: ["GET /repos/{owner}/{repo}/git/ref/{ref}"], - getTag: ["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"], - getTree: ["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"], - listMatchingRefs: ["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"], - updateRef: ["PATCH /repos/{owner}/{repo}/git/refs/{ref}"], - }, - gitignore: { - getAllTemplates: ["GET /gitignore/templates"], - getTemplate: ["GET /gitignore/templates/{name}"], - }, - issues: { - addAssignees: [ - "POST /repos/{owner}/{repo}/issues/{issue_number}/assignees", - ], - addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"], - checkUserCanBeAssigned: ["GET /repos/{owner}/{repo}/assignees/{assignee}"], - create: ["POST /repos/{owner}/{repo}/issues"], - createComment: [ - "POST /repos/{owner}/{repo}/issues/{issue_number}/comments", - ], - createLabel: ["POST /repos/{owner}/{repo}/labels"], - createMilestone: ["POST /repos/{owner}/{repo}/milestones"], - deleteComment: [ - "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}", - ], - deleteLabel: ["DELETE /repos/{owner}/{repo}/labels/{name}"], - deleteMilestone: [ - "DELETE /repos/{owner}/{repo}/milestones/{milestone_number}", - ], - get: ["GET /repos/{owner}/{repo}/issues/{issue_number}"], - getComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"], - getEvent: ["GET /repos/{owner}/{repo}/issues/events/{event_id}"], - getLabel: ["GET /repos/{owner}/{repo}/labels/{name}"], - getMilestone: ["GET /repos/{owner}/{repo}/milestones/{milestone_number}"], - list: ["GET /issues"], - listAssignees: ["GET /repos/{owner}/{repo}/assignees"], - listComments: ["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"], - listCommentsForRepo: ["GET /repos/{owner}/{repo}/issues/comments"], - listEvents: ["GET /repos/{owner}/{repo}/issues/{issue_number}/events"], - listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"], - listEventsForTimeline: [ - "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", - ], - listForAuthenticatedUser: ["GET /user/issues"], - listForOrg: ["GET /orgs/{org}/issues"], - listForRepo: ["GET /repos/{owner}/{repo}/issues"], - listLabelsForMilestone: [ - "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels", - ], - listLabelsForRepo: ["GET /repos/{owner}/{repo}/labels"], - listLabelsOnIssue: [ - "GET /repos/{owner}/{repo}/issues/{issue_number}/labels", - ], - listMilestones: ["GET /repos/{owner}/{repo}/milestones"], - lock: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"], - removeAllLabels: [ - "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels", - ], - removeAssignees: [ - "DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees", - ], - removeLabel: [ - "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", - ], - setLabels: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"], - unlock: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"], - update: ["PATCH /repos/{owner}/{repo}/issues/{issue_number}"], - updateComment: ["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"], - updateLabel: ["PATCH /repos/{owner}/{repo}/labels/{name}"], - updateMilestone: [ - "PATCH /repos/{owner}/{repo}/milestones/{milestone_number}", - ], - }, - licenses: { - get: ["GET /licenses/{license}"], - getAllCommonlyUsed: ["GET /licenses"], - getForRepo: ["GET /repos/{owner}/{repo}/license"], - }, - markdown: { - render: ["POST /markdown"], - renderRaw: [ - "POST /markdown/raw", - { headers: { "content-type": "text/plain; charset=utf-8" } }, - ], - }, - meta: { - get: ["GET /meta"], - getOctocat: ["GET /octocat"], - getZen: ["GET /zen"], - root: ["GET /"], - }, - orgs: { - checkMembershipForUser: ["GET /orgs/{org}/members/{username}"], - checkPublicMembershipForUser: ["GET /orgs/{org}/public_members/{username}"], - convertMemberToOutsideCollaborator: [ - "PUT /orgs/{org}/outside_collaborators/{username}", - ], - createWebhook: ["POST /orgs/{org}/hooks"], - deleteWebhook: ["DELETE /orgs/{org}/hooks/{hook_id}"], - get: ["GET /orgs/{org}"], - getMembershipForAuthenticatedUser: ["GET /user/memberships/orgs/{org}"], - getMembershipForUser: ["GET /orgs/{org}/memberships/{username}"], - getWebhook: ["GET /orgs/{org}/hooks/{hook_id}"], - getWebhookConfigForOrg: ["GET /orgs/{org}/hooks/{hook_id}/config"], - getWebhookDelivery: [ - "GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}", - ], - list: ["GET /organizations"], - listAppInstallations: ["GET /orgs/{org}/installations"], - listForAuthenticatedUser: ["GET /user/orgs"], - listForUser: ["GET /users/{username}/orgs"], - listMembers: ["GET /orgs/{org}/members"], - listMembershipsForAuthenticatedUser: ["GET /user/memberships/orgs"], - listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], - listPublicMembers: ["GET /orgs/{org}/public_members"], - listWebhookDeliveries: ["GET /orgs/{org}/hooks/{hook_id}/deliveries"], - listWebhooks: ["GET /orgs/{org}/hooks"], - pingWebhook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], - redeliverWebhookDelivery: [ - "POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - ], - removeMember: ["DELETE /orgs/{org}/members/{username}"], - removeMembershipForUser: ["DELETE /orgs/{org}/memberships/{username}"], - removeOutsideCollaborator: [ - "DELETE /orgs/{org}/outside_collaborators/{username}", - ], - removePublicMembershipForAuthenticatedUser: [ - "DELETE /orgs/{org}/public_members/{username}", - ], - setMembershipForUser: ["PUT /orgs/{org}/memberships/{username}"], - setPublicMembershipForAuthenticatedUser: [ - "PUT /orgs/{org}/public_members/{username}", - ], - update: ["PATCH /orgs/{org}"], - updateMembershipForAuthenticatedUser: [ - "PATCH /user/memberships/orgs/{org}", - ], - updateWebhook: ["PATCH /orgs/{org}/hooks/{hook_id}"], - updateWebhookConfigForOrg: ["PATCH /orgs/{org}/hooks/{hook_id}/config"], - }, - projects: { - addCollaborator: ["PUT /projects/{project_id}/collaborators/{username}"], - createCard: ["POST /projects/columns/{column_id}/cards"], - createColumn: ["POST /projects/{project_id}/columns"], - createForAuthenticatedUser: ["POST /user/projects"], - createForOrg: ["POST /orgs/{org}/projects"], - createForRepo: ["POST /repos/{owner}/{repo}/projects"], - delete: ["DELETE /projects/{project_id}"], - deleteCard: ["DELETE /projects/columns/cards/{card_id}"], - deleteColumn: ["DELETE /projects/columns/{column_id}"], - get: ["GET /projects/{project_id}"], - getCard: ["GET /projects/columns/cards/{card_id}"], - getColumn: ["GET /projects/columns/{column_id}"], - getPermissionForUser: [ - "GET /projects/{project_id}/collaborators/{username}/permission", - ], - listCards: ["GET /projects/columns/{column_id}/cards"], - listCollaborators: ["GET /projects/{project_id}/collaborators"], - listColumns: ["GET /projects/{project_id}/columns"], - listForOrg: ["GET /orgs/{org}/projects"], - listForRepo: ["GET /repos/{owner}/{repo}/projects"], - listForUser: ["GET /users/{username}/projects"], - moveCard: ["POST /projects/columns/cards/{card_id}/moves"], - moveColumn: ["POST /projects/columns/{column_id}/moves"], - removeCollaborator: [ - "DELETE /projects/{project_id}/collaborators/{username}", - ], - update: ["PATCH /projects/{project_id}"], - updateCard: ["PATCH /projects/columns/cards/{card_id}"], - updateColumn: ["PATCH /projects/columns/{column_id}"], - }, - pulls: { - checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], - create: ["POST /repos/{owner}/{repo}/pulls"], - createReplyForReviewComment: [ - "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", - ], - createReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], - createReviewComment: [ - "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments", - ], - deletePendingReview: [ - "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - ], - deleteReviewComment: [ - "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}", - ], - dismissReview: [ - "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", - ], - get: ["GET /repos/{owner}/{repo}/pulls/{pull_number}"], - getReview: [ - "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - ], - getReviewComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"], - list: ["GET /repos/{owner}/{repo}/pulls"], - listCommentsForReview: [ - "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", - ], - listCommits: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"], - listFiles: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"], - listRequestedReviewers: [ - "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - ], - listReviewComments: [ - "GET /repos/{owner}/{repo}/pulls/{pull_number}/comments", - ], - listReviewCommentsForRepo: ["GET /repos/{owner}/{repo}/pulls/comments"], - listReviews: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], - merge: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"], - removeRequestedReviewers: [ - "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - ], - requestReviewers: [ - "POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", - ], - submitReview: [ - "POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", - ], - update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"], - updateBranch: [ - "PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch", - ], - updateReview: [ - "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", - ], - updateReviewComment: [ - "PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}", - ], - }, - rateLimit: { get: ["GET /rate_limit"] }, - reactions: { - createForCommitComment: [ - "POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", - ], - createForIssue: [ - "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", - ], - createForIssueComment: [ - "POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - ], - createForPullRequestReviewComment: [ - "POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - ], - createForRelease: [ - "POST /repos/{owner}/{repo}/releases/{release_id}/reactions", - ], - createForTeamDiscussionCommentInOrg: [ - "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - ], - createForTeamDiscussionCommentLegacy: [ - "POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - {}, - { - deprecated: - "octokit.scim.createForTeamDiscussionCommentLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment-legacy", - }, - ], - createForTeamDiscussionInOrg: [ - "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - ], - createForTeamDiscussionLegacy: [ - "POST /teams/{team_id}/discussions/{discussion_number}/reactions", - {}, - { - deprecated: - "octokit.scim.createForTeamDiscussionLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#create-reaction-for-a-team-discussion-legacy", - }, - ], - deleteForCommitComment: [ - "DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}", - ], - deleteForIssue: [ - "DELETE /repos/{owner}/{repo}/issues/{issue_number}/reactions/{reaction_id}", - ], - deleteForIssueComment: [ - "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions/{reaction_id}", - ], - deleteForPullRequestComment: [ - "DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}", - ], - deleteForRelease: [ - "DELETE /repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}", - ], - deleteForTeamDiscussion: [ - "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", - ], - deleteForTeamDiscussionComment: [ - "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", - ], - deleteLegacy: [ - "DELETE /reactions/{reaction_id}", - {}, - { - deprecated: - "octokit.scim.deleteLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#delete-a-reaction-legacy", - }, - ], - listForCommitComment: [ - "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", - ], - listForIssue: ["GET /repos/{owner}/{repo}/issues/{issue_number}/reactions"], - listForIssueComment: [ - "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - ], - listForPullRequestReviewComment: [ - "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", - ], - listForRelease: [ - "GET /repos/{owner}/{repo}/releases/{release_id}/reactions", - ], - listForTeamDiscussionCommentInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", - ], - listForTeamDiscussionCommentLegacy: [ - "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - {}, - { - deprecated: - "octokit.scim.listForTeamDiscussionCommentLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment-legacy", - }, - ], - listForTeamDiscussionInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - ], - listForTeamDiscussionLegacy: [ - "GET /teams/{team_id}/discussions/{discussion_number}/reactions", - {}, - { - deprecated: - "octokit.scim.listForTeamDiscussionLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/reactions/#list-reactions-for-a-team-discussion-legacy", - }, - ], - }, - repos: { - acceptInvitation: [ - "PATCH /user/repository_invitations/{invitation_id}", - {}, - { renamed: ["repos", "acceptInvitationForAuthenticatedUser"] }, - ], - acceptInvitationForAuthenticatedUser: [ - "PATCH /user/repository_invitations/{invitation_id}", - ], - addAppAccessRestrictions: [ - "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - ], - addCollaborator: ["PUT /repos/{owner}/{repo}/collaborators/{username}"], - addStatusCheckContexts: [ - "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - ], - addTeamAccessRestrictions: [ - "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - ], - addUserAccessRestrictions: [ - "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - ], - checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], - compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], - compareCommitsWithBasehead: [ - "GET /repos/{owner}/{repo}/compare/{basehead}", - ], - createAutolink: ["POST /repos/{owner}/{repo}/autolinks"], - createCommitComment: [ - "POST /repos/{owner}/{repo}/commits/{commit_sha}/comments", - ], - createCommitSignatureProtection: [ - "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - ], - createCommitStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"], - createDeployKey: ["POST /repos/{owner}/{repo}/keys"], - createDeployment: ["POST /repos/{owner}/{repo}/deployments"], - createDeploymentBranchPolicy: [ - "POST /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - ], - createDeploymentStatus: [ - "POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - ], - createDispatchEvent: ["POST /repos/{owner}/{repo}/dispatches"], - createForAuthenticatedUser: ["POST /user/repos"], - createFork: ["POST /repos/{owner}/{repo}/forks"], - createInOrg: ["POST /orgs/{org}/repos"], - createOrUpdateEnvironment: [ - "PUT /repos/{owner}/{repo}/environments/{environment_name}", - ], - createOrUpdateFileContents: ["PUT /repos/{owner}/{repo}/contents/{path}"], - createPagesSite: ["POST /repos/{owner}/{repo}/pages"], - createRelease: ["POST /repos/{owner}/{repo}/releases"], - createUsingTemplate: [ - "POST /repos/{template_owner}/{template_repo}/generate", - ], - createWebhook: ["POST /repos/{owner}/{repo}/hooks"], - declineInvitation: [ - "DELETE /user/repository_invitations/{invitation_id}", - {}, - { renamed: ["repos", "declineInvitationForAuthenticatedUser"] }, - ], - declineInvitationForAuthenticatedUser: [ - "DELETE /user/repository_invitations/{invitation_id}", - ], - delete: ["DELETE /repos/{owner}/{repo}"], - deleteAccessRestrictions: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - ], - deleteAdminBranchProtection: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - ], - deleteAnEnvironment: [ - "DELETE /repos/{owner}/{repo}/environments/{environment_name}", - ], - deleteAutolink: ["DELETE /repos/{owner}/{repo}/autolinks/{autolink_id}"], - deleteBranchProtection: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection", - ], - deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"], - deleteCommitSignatureProtection: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - ], - deleteDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"], - deleteDeployment: [ - "DELETE /repos/{owner}/{repo}/deployments/{deployment_id}", - ], - deleteDeploymentBranchPolicy: [ - "DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - ], - deleteFile: ["DELETE /repos/{owner}/{repo}/contents/{path}"], - deleteInvitation: [ - "DELETE /repos/{owner}/{repo}/invitations/{invitation_id}", - ], - deletePagesSite: ["DELETE /repos/{owner}/{repo}/pages"], - deletePullRequestReviewProtection: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - ], - deleteRelease: ["DELETE /repos/{owner}/{repo}/releases/{release_id}"], - deleteReleaseAsset: [ - "DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}", - ], - deleteWebhook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], - disableLfsForRepo: ["DELETE /repos/{owner}/{repo}/lfs"], - downloadTarballArchive: ["GET /repos/{owner}/{repo}/tarball/{ref}"], - downloadZipballArchive: ["GET /repos/{owner}/{repo}/zipball/{ref}"], - enableLfsForRepo: ["PUT /repos/{owner}/{repo}/lfs"], - generateReleaseNotes: [ - "POST /repos/{owner}/{repo}/releases/generate-notes", - ], - get: ["GET /repos/{owner}/{repo}"], - getAccessRestrictions: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions", - ], - getAdminBranchProtection: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - ], - getAllEnvironments: ["GET /repos/{owner}/{repo}/environments"], - getAllStatusCheckContexts: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - ], - getAllTopics: ["GET /repos/{owner}/{repo}/topics"], - getAppsWithAccessToProtectedBranch: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - ], - getAutolink: ["GET /repos/{owner}/{repo}/autolinks/{autolink_id}"], - getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"], - getBranchProtection: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection", - ], - getCodeFrequencyStats: ["GET /repos/{owner}/{repo}/stats/code_frequency"], - getCollaboratorPermissionLevel: [ - "GET /repos/{owner}/{repo}/collaborators/{username}/permission", - ], - getCombinedStatusForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/status"], - getCommit: ["GET /repos/{owner}/{repo}/commits/{ref}"], - getCommitActivityStats: ["GET /repos/{owner}/{repo}/stats/commit_activity"], - getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"], - getCommitSignatureProtection: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", - ], - getContent: ["GET /repos/{owner}/{repo}/contents/{path}"], - getContributorsStats: ["GET /repos/{owner}/{repo}/stats/contributors"], - getDeployKey: ["GET /repos/{owner}/{repo}/keys/{key_id}"], - getDeployment: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}"], - getDeploymentBranchPolicy: [ - "GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - ], - getDeploymentStatus: [ - "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - ], - getEnvironment: [ - "GET /repos/{owner}/{repo}/environments/{environment_name}", - ], - getLatestPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/latest"], - getLatestRelease: ["GET /repos/{owner}/{repo}/releases/latest"], - getPages: ["GET /repos/{owner}/{repo}/pages"], - getPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/{build_id}"], - getParticipationStats: ["GET /repos/{owner}/{repo}/stats/participation"], - getPullRequestReviewProtection: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - ], - getPunchCardStats: ["GET /repos/{owner}/{repo}/stats/punch_card"], - getReadme: ["GET /repos/{owner}/{repo}/readme"], - getReadmeInDirectory: ["GET /repos/{owner}/{repo}/readme/{dir}"], - getRelease: ["GET /repos/{owner}/{repo}/releases/{release_id}"], - getReleaseAsset: ["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"], - getReleaseByTag: ["GET /repos/{owner}/{repo}/releases/tags/{tag}"], - getStatusChecksProtection: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - ], - getTeamsWithAccessToProtectedBranch: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - ], - getUsersWithAccessToProtectedBranch: [ - "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - ], - getWebhook: ["GET /repos/{owner}/{repo}/hooks/{hook_id}"], - getWebhookConfigForRepo: [ - "GET /repos/{owner}/{repo}/hooks/{hook_id}/config", - ], - getWebhookDelivery: [ - "GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}", - ], - listAutolinks: ["GET /repos/{owner}/{repo}/autolinks"], - listBranches: ["GET /repos/{owner}/{repo}/branches"], - listBranchesForHeadCommit: [ - "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", - ], - listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"], - listCommentsForCommit: [ - "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments", - ], - listCommitCommentsForRepo: ["GET /repos/{owner}/{repo}/comments"], - listCommitStatusesForRef: [ - "GET /repos/{owner}/{repo}/commits/{ref}/statuses", - ], - listCommits: ["GET /repos/{owner}/{repo}/commits"], - listContributors: ["GET /repos/{owner}/{repo}/contributors"], - listDeployKeys: ["GET /repos/{owner}/{repo}/keys"], - listDeploymentBranchPolicies: [ - "GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies", - ], - listDeploymentStatuses: [ - "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - ], - listDeployments: ["GET /repos/{owner}/{repo}/deployments"], - listForAuthenticatedUser: ["GET /user/repos"], - listForOrg: ["GET /orgs/{org}/repos"], - listForUser: ["GET /users/{username}/repos"], - listForks: ["GET /repos/{owner}/{repo}/forks"], - listInvitations: ["GET /repos/{owner}/{repo}/invitations"], - listInvitationsForAuthenticatedUser: ["GET /user/repository_invitations"], - listLanguages: ["GET /repos/{owner}/{repo}/languages"], - listPagesBuilds: ["GET /repos/{owner}/{repo}/pages/builds"], - listPublic: ["GET /repositories"], - listPullRequestsAssociatedWithCommit: [ - "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", - ], - listReleaseAssets: [ - "GET /repos/{owner}/{repo}/releases/{release_id}/assets", - ], - listReleases: ["GET /repos/{owner}/{repo}/releases"], - listTags: ["GET /repos/{owner}/{repo}/tags"], - listTeams: ["GET /repos/{owner}/{repo}/teams"], - listWebhookDeliveries: [ - "GET /repos/{owner}/{repo}/hooks/{hook_id}/deliveries", - ], - listWebhooks: ["GET /repos/{owner}/{repo}/hooks"], - merge: ["POST /repos/{owner}/{repo}/merges"], - mergeUpstream: ["POST /repos/{owner}/{repo}/merge-upstream"], - pingWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"], - redeliverWebhookDelivery: [ - "POST /repos/{owner}/{repo}/hooks/{hook_id}/deliveries/{delivery_id}/attempts", - ], - removeAppAccessRestrictions: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - ], - removeCollaborator: [ - "DELETE /repos/{owner}/{repo}/collaborators/{username}", - ], - removeStatusCheckContexts: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - ], - removeStatusCheckProtection: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - ], - removeTeamAccessRestrictions: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - ], - removeUserAccessRestrictions: [ - "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - ], - renameBranch: ["POST /repos/{owner}/{repo}/branches/{branch}/rename"], - replaceAllTopics: ["PUT /repos/{owner}/{repo}/topics"], - requestPagesBuild: ["POST /repos/{owner}/{repo}/pages/builds"], - setAdminBranchProtection: [ - "POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - ], - setAppAccessRestrictions: [ - "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - ], - setStatusCheckContexts: [ - "PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - ], - setTeamAccessRestrictions: [ - "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - ], - setUserAccessRestrictions: [ - "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", - ], - testPushWebhook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"], - transfer: ["POST /repos/{owner}/{repo}/transfer"], - update: ["PATCH /repos/{owner}/{repo}"], - updateBranchProtection: [ - "PUT /repos/{owner}/{repo}/branches/{branch}/protection", - ], - updateCommitComment: ["PATCH /repos/{owner}/{repo}/comments/{comment_id}"], - updateDeploymentBranchPolicy: [ - "PUT /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}", - ], - updateInformationAboutPagesSite: ["PUT /repos/{owner}/{repo}/pages"], - updateInvitation: [ - "PATCH /repos/{owner}/{repo}/invitations/{invitation_id}", - ], - updatePullRequestReviewProtection: [ - "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", - ], - updateRelease: ["PATCH /repos/{owner}/{repo}/releases/{release_id}"], - updateReleaseAsset: [ - "PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}", - ], - updateStatusCheckProtection: [ - "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", - ], - updateWebhook: ["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"], - updateWebhookConfigForRepo: [ - "PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config", - ], - uploadReleaseAsset: [ - "POST {origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", - ], - }, - search: { - code: ["GET /search/code"], - commits: ["GET /search/commits"], - issuesAndPullRequests: ["GET /search/issues"], - labels: ["GET /search/labels"], - repos: ["GET /search/repositories"], - topics: ["GET /search/topics"], - users: ["GET /search/users"], - }, - secretScanning: { - getAlert: [ - "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - ], - listAlertsForOrg: ["GET /orgs/{org}/secret-scanning/alerts"], - listAlertsForRepo: ["GET /repos/{owner}/{repo}/secret-scanning/alerts"], - listLocationsForAlert: [ - "GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations", - ], - updateAlert: [ - "PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}", - ], - }, - teams: { - addMemberLegacy: [ - "PUT /teams/{team_id}/members/{username}", - {}, - { - deprecated: - "octokit.scim.addMemberLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#add-team-member-legacy", - }, - ], - addOrUpdateMembershipForUserInOrg: [ - "PUT /orgs/{org}/teams/{team_slug}/memberships/{username}", - ], - addOrUpdateMembershipForUserLegacy: [ - "PUT /teams/{team_id}/memberships/{username}", - {}, - { - deprecated: - "octokit.scim.addOrUpdateMembershipForUserLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#add-or-update-team-membership-for-a-user-legacy", - }, - ], - addOrUpdateProjectPermissionsInOrg: [ - "PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", - ], - addOrUpdateProjectPermissionsLegacy: [ - "PUT /teams/{team_id}/projects/{project_id}", - {}, - { - deprecated: - "octokit.scim.addOrUpdateProjectPermissionsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#add-or-update-team-project-permissions-legacy", - }, - ], - addOrUpdateRepoPermissionsInOrg: [ - "PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - ], - addOrUpdateRepoPermissionsLegacy: [ - "PUT /teams/{team_id}/repos/{owner}/{repo}", - {}, - { - deprecated: - "octokit.scim.addOrUpdateRepoPermissionsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#add-or-update-team-repository-permissions-legacy", - }, - ], - checkPermissionsForProjectInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", - ], - checkPermissionsForProjectLegacy: [ - "GET /teams/{team_id}/projects/{project_id}", - {}, - { - deprecated: - "octokit.scim.checkPermissionsForProjectLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#check-team-permissions-for-a-project-legacy", - }, - ], - checkPermissionsForRepoInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - ], - checkPermissionsForRepoLegacy: [ - "GET /teams/{team_id}/repos/{owner}/{repo}", - {}, - { - deprecated: - "octokit.scim.checkPermissionsForRepoLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#check-team-permissions-for-a-repository-legacy", - }, - ], - create: ["POST /orgs/{org}/teams"], - createDiscussionCommentInOrg: [ - "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - ], - createDiscussionCommentLegacy: [ - "POST /teams/{team_id}/discussions/{discussion_number}/comments", - {}, - { - deprecated: - "octokit.scim.createDiscussionCommentLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#create-a-discussion-comment-legacy", - }, - ], - createDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions"], - createDiscussionLegacy: [ - "POST /teams/{team_id}/discussions", - {}, - { - deprecated: - "octokit.scim.createDiscussionLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#create-a-discussion-legacy", - }, - ], - deleteDiscussionCommentInOrg: [ - "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - ], - deleteDiscussionCommentLegacy: [ - "DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - {}, - { - deprecated: - "octokit.scim.deleteDiscussionCommentLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#delete-a-discussion-comment-legacy", - }, - ], - deleteDiscussionInOrg: [ - "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - ], - deleteDiscussionLegacy: [ - "DELETE /teams/{team_id}/discussions/{discussion_number}", - {}, - { - deprecated: - "octokit.scim.deleteDiscussionLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#delete-a-discussion-legacy", - }, - ], - deleteInOrg: ["DELETE /orgs/{org}/teams/{team_slug}"], - deleteLegacy: [ - "DELETE /teams/{team_id}", - {}, - { - deprecated: - "octokit.scim.deleteLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#delete-a-team-legacy", - }, - ], - getByName: ["GET /orgs/{org}/teams/{team_slug}"], - getDiscussionCommentInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - ], - getDiscussionCommentLegacy: [ - "GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - {}, - { - deprecated: - "octokit.scim.getDiscussionCommentLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-a-discussion-comment-legacy", - }, - ], - getDiscussionInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - ], - getDiscussionLegacy: [ - "GET /teams/{team_id}/discussions/{discussion_number}", - {}, - { - deprecated: - "octokit.scim.getDiscussionLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-a-discussion-legacy", - }, - ], - getLegacy: [ - "GET /teams/{team_id}", - {}, - { - deprecated: - "octokit.scim.getLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#get-a-team-legacy", - }, - ], - getMemberLegacy: [ - "GET /teams/{team_id}/members/{username}", - {}, - { - deprecated: - "octokit.scim.getMemberLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-team-member-legacy", - }, - ], - getMembershipForUserInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/memberships/{username}", - ], - getMembershipForUserLegacy: [ - "GET /teams/{team_id}/memberships/{username}", - {}, - { - deprecated: - "octokit.scim.getMembershipForUserLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#get-team-membership-for-a-user-legacy", - }, - ], - list: ["GET /orgs/{org}/teams"], - listChildInOrg: ["GET /orgs/{org}/teams/{team_slug}/teams"], - listChildLegacy: [ - "GET /teams/{team_id}/teams", - {}, - { - deprecated: - "octokit.scim.listChildLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#list-child-teams-legacy", - }, - ], - listDiscussionCommentsInOrg: [ - "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - ], - listDiscussionCommentsLegacy: [ - "GET /teams/{team_id}/discussions/{discussion_number}/comments", - {}, - { - deprecated: - "octokit.scim.listDiscussionCommentsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-discussion-comments-legacy", - }, - ], - listDiscussionsInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions"], - listDiscussionsLegacy: [ - "GET /teams/{team_id}/discussions", - {}, - { - deprecated: - "octokit.scim.listDiscussionsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-discussions-legacy", - }, - ], - listForAuthenticatedUser: ["GET /user/teams"], - listMembersInOrg: ["GET /orgs/{org}/teams/{team_slug}/members"], - listMembersLegacy: [ - "GET /teams/{team_id}/members", - {}, - { - deprecated: - "octokit.scim.listMembersLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#list-team-members-legacy", - }, - ], - listProjectsInOrg: ["GET /orgs/{org}/teams/{team_slug}/projects"], - listProjectsLegacy: [ - "GET /teams/{team_id}/projects", - {}, - { - deprecated: - "octokit.scim.listProjectsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#list-team-projects-legacy", - }, - ], - listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], - listReposLegacy: [ - "GET /teams/{team_id}/repos", - {}, - { - deprecated: - "octokit.scim.listReposLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#list-team-repositories-legacy", - }, - ], - removeMemberLegacy: [ - "DELETE /teams/{team_id}/members/{username}", - {}, - { - deprecated: - "octokit.scim.removeMemberLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#remove-team-member-legacy", - }, - ], - removeMembershipForUserInOrg: [ - "DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}", - ], - removeMembershipForUserLegacy: [ - "DELETE /teams/{team_id}/memberships/{username}", - {}, - { - deprecated: - "octokit.scim.removeMembershipForUserLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#remove-team-membership-for-a-user-legacy", - }, - ], - removeProjectInOrg: [ - "DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}", - ], - removeProjectLegacy: [ - "DELETE /teams/{team_id}/projects/{project_id}", - {}, - { - deprecated: - "octokit.scim.removeProjectLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#remove-a-project-from-a-team-legacy", - }, - ], - removeRepoInOrg: [ - "DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", - ], - removeRepoLegacy: [ - "DELETE /teams/{team_id}/repos/{owner}/{repo}", - {}, - { - deprecated: - "octokit.scim.removeRepoLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#remove-a-repository-from-a-team-legacy", - }, - ], - updateDiscussionCommentInOrg: [ - "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", - ], - updateDiscussionCommentLegacy: [ - "PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - {}, - { - deprecated: - "octokit.scim.updateDiscussionCommentLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#update-a-discussion-comment-legacy", - }, - ], - updateDiscussionInOrg: [ - "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - ], - updateDiscussionLegacy: [ - "PATCH /teams/{team_id}/discussions/{discussion_number}", - {}, - { - deprecated: - "octokit.scim.updateDiscussionLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams#update-a-discussion-legacy", - }, - ], - updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"], - updateLegacy: [ - "PATCH /teams/{team_id}", - {}, - { - deprecated: - "octokit.scim.updateLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/teams/#update-a-team-legacy", - }, - ], - }, - users: { - addEmailForAuthenticated: [ - "POST /user/emails", - {}, - { renamed: ["users", "addEmailForAuthenticatedUser"] }, - ], - addEmailForAuthenticatedUser: ["POST /user/emails"], - checkFollowingForUser: ["GET /users/{username}/following/{target_user}"], - checkPersonIsFollowedByAuthenticated: ["GET /user/following/{username}"], - createGpgKeyForAuthenticated: [ - "POST /user/gpg_keys", - {}, - { renamed: ["users", "createGpgKeyForAuthenticatedUser"] }, - ], - createGpgKeyForAuthenticatedUser: ["POST /user/gpg_keys"], - createPublicSshKeyForAuthenticated: [ - "POST /user/keys", - {}, - { renamed: ["users", "createPublicSshKeyForAuthenticatedUser"] }, - ], - createPublicSshKeyForAuthenticatedUser: ["POST /user/keys"], - deleteEmailForAuthenticated: [ - "DELETE /user/emails", - {}, - { renamed: ["users", "deleteEmailForAuthenticatedUser"] }, - ], - deleteEmailForAuthenticatedUser: ["DELETE /user/emails"], - deleteGpgKeyForAuthenticated: [ - "DELETE /user/gpg_keys/{gpg_key_id}", - {}, - { renamed: ["users", "deleteGpgKeyForAuthenticatedUser"] }, - ], - deleteGpgKeyForAuthenticatedUser: ["DELETE /user/gpg_keys/{gpg_key_id}"], - deletePublicSshKeyForAuthenticated: [ - "DELETE /user/keys/{key_id}", - {}, - { renamed: ["users", "deletePublicSshKeyForAuthenticatedUser"] }, - ], - deletePublicSshKeyForAuthenticatedUser: ["DELETE /user/keys/{key_id}"], - follow: ["PUT /user/following/{username}"], - getAuthenticated: ["GET /user"], - getByUsername: ["GET /users/{username}"], - getContextForUser: ["GET /users/{username}/hovercard"], - getGpgKeyForAuthenticated: [ - "GET /user/gpg_keys/{gpg_key_id}", - {}, - { renamed: ["users", "getGpgKeyForAuthenticatedUser"] }, - ], - getGpgKeyForAuthenticatedUser: ["GET /user/gpg_keys/{gpg_key_id}"], - getPublicSshKeyForAuthenticated: [ - "GET /user/keys/{key_id}", - {}, - { renamed: ["users", "getPublicSshKeyForAuthenticatedUser"] }, - ], - getPublicSshKeyForAuthenticatedUser: ["GET /user/keys/{key_id}"], - list: ["GET /users"], - listEmailsForAuthenticated: [ - "GET /user/emails", - {}, - { renamed: ["users", "listEmailsForAuthenticatedUser"] }, - ], - listEmailsForAuthenticatedUser: ["GET /user/emails"], - listFollowedByAuthenticated: [ - "GET /user/following", - {}, - { renamed: ["users", "listFollowedByAuthenticatedUser"] }, - ], - listFollowedByAuthenticatedUser: ["GET /user/following"], - listFollowersForAuthenticatedUser: ["GET /user/followers"], - listFollowersForUser: ["GET /users/{username}/followers"], - listFollowingForUser: ["GET /users/{username}/following"], - listGpgKeysForAuthenticated: [ - "GET /user/gpg_keys", - {}, - { renamed: ["users", "listGpgKeysForAuthenticatedUser"] }, - ], - listGpgKeysForAuthenticatedUser: ["GET /user/gpg_keys"], - listGpgKeysForUser: ["GET /users/{username}/gpg_keys"], - listPublicEmailsForAuthenticated: [ - "GET /user/public_emails", - {}, - { renamed: ["users", "listPublicEmailsForAuthenticatedUser"] }, - ], - listPublicEmailsForAuthenticatedUser: ["GET /user/public_emails"], - listPublicKeysForUser: ["GET /users/{username}/keys"], - listPublicSshKeysForAuthenticated: [ - "GET /user/keys", - {}, - { renamed: ["users", "listPublicSshKeysForAuthenticatedUser"] }, - ], - listPublicSshKeysForAuthenticatedUser: ["GET /user/keys"], - unfollow: ["DELETE /user/following/{username}"], - updateAuthenticated: ["PATCH /user"], - }, -}; - -export default Endpoints; diff --git a/src/generated/ghe-34-endpoints.ts b/src/generated/ghe-34-endpoints.ts index 889cb546..5fe068f4 100644 --- a/src/generated/ghe-34-endpoints.ts +++ b/src/generated/ghe-34-endpoints.ts @@ -243,22 +243,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { addRepoToInstallationForAuthenticatedUser: [ "PUT /user/installations/{installation_id}/repositories/{repository_id}", ], - checkAuthorization: [ - "GET /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.checkAuthorization() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#check-an-authorization", - }, - ], checkToken: ["POST /applications/{client_id}/token"], - createContentAttachment: [ - "POST /content_references/{content_reference_id}/attachments", - { mediaType: { previews: ["corsair"] } }, - ], - createContentAttachmentForRepo: [ - "POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", - ], createFromManifest: ["POST /app-manifests/{code}/conversions"], createInstallationAccessToken: [ "POST /app/installations/{installation_id}/access_tokens", @@ -292,31 +277,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { removeRepoFromInstallationForAuthenticatedUser: [ "DELETE /user/installations/{installation_id}/repositories/{repository_id}", ], - resetAuthorization: [ - "POST /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.resetAuthorization() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#reset-an-authorization", - }, - ], resetToken: ["PATCH /applications/{client_id}/token"], - revokeAuthorizationForApplication: [ - "DELETE /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.revokeAuthorizationForApplication() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-an-authorization-for-an-application", - }, - ], - revokeGrantForApplication: [ - "DELETE /applications/{client_id}/grants/{access_token}", - {}, - { - deprecated: - "octokit.scim.revokeGrantForApplication() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-a-grant-for-an-application", - }, - ], revokeInstallationAccessToken: ["DELETE /installation/token"], scopeToken: ["POST /applications/{client_id}/token/scoped"], suspendInstallation: ["PUT /app/installations/{installation_id}/suspended"], @@ -384,14 +345,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { codesOfConduct: { getAllCodesOfConduct: ["GET /codes_of_conduct"], getConductCode: ["GET /codes_of_conduct/{key}"], - getForRepo: [ - "GET /repos/{owner}/{repo}/community/code_of_conduct", - { mediaType: { previews: ["scarlet-witch"] } }, - { - deprecated: - "octokit.scim.getForRepo() is deprecated, see https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository", - }, - ], }, dependabot: { addSelectedRepoToOrgSecret: [ @@ -621,6 +574,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"], checkUserCanBeAssigned: ["GET /repos/{owner}/{repo}/assignees/{assignee}"], + checkUserCanBeAssignedToIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}", + ], create: ["POST /repos/{owner}/{repo}/issues"], createComment: [ "POST /repos/{owner}/{repo}/issues/{issue_number}/comments", @@ -1326,7 +1282,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { {}, { deprecated: - "octokit.scim.addOrUpdateRepoPermissionsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.4/rest/reference/teams/#add-or-update-team-repository-permissions-legacy", + "octokit.scim.addOrUpdateRepoPermissionsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.4/rest/reference/teams#add-or-update-team-repository-permissions-legacy", }, ], checkPermissionsForProjectInOrg: [ diff --git a/src/generated/ghe-35-endpoints.ts b/src/generated/ghe-35-endpoints.ts index be8008c2..3d216cf9 100644 --- a/src/generated/ghe-35-endpoints.ts +++ b/src/generated/ghe-35-endpoints.ts @@ -290,22 +290,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { addRepoToInstallationForAuthenticatedUser: [ "PUT /user/installations/{installation_id}/repositories/{repository_id}", ], - checkAuthorization: [ - "GET /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.checkAuthorization() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#check-an-authorization", - }, - ], checkToken: ["POST /applications/{client_id}/token"], - createContentAttachment: [ - "POST /content_references/{content_reference_id}/attachments", - { mediaType: { previews: ["corsair"] } }, - ], - createContentAttachmentForRepo: [ - "POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", - ], createFromManifest: ["POST /app-manifests/{code}/conversions"], createInstallationAccessToken: [ "POST /app/installations/{installation_id}/access_tokens", @@ -339,31 +324,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { removeRepoFromInstallationForAuthenticatedUser: [ "DELETE /user/installations/{installation_id}/repositories/{repository_id}", ], - resetAuthorization: [ - "POST /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.resetAuthorization() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#reset-an-authorization", - }, - ], resetToken: ["PATCH /applications/{client_id}/token"], - revokeAuthorizationForApplication: [ - "DELETE /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.revokeAuthorizationForApplication() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-an-authorization-for-an-application", - }, - ], - revokeGrantForApplication: [ - "DELETE /applications/{client_id}/grants/{access_token}", - {}, - { - deprecated: - "octokit.scim.revokeGrantForApplication() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-a-grant-for-an-application", - }, - ], revokeInstallationAccessToken: ["DELETE /installation/token"], scopeToken: ["POST /applications/{client_id}/token/scoped"], suspendInstallation: ["PUT /app/installations/{installation_id}/suspended"], @@ -432,14 +393,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { codesOfConduct: { getAllCodesOfConduct: ["GET /codes_of_conduct"], getConductCode: ["GET /codes_of_conduct/{key}"], - getForRepo: [ - "GET /repos/{owner}/{repo}/community/code_of_conduct", - { mediaType: { previews: ["scarlet-witch"] } }, - { - deprecated: - "octokit.scim.getForRepo() is deprecated, see https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository", - }, - ], }, dependabot: { addSelectedRepoToOrgSecret: [ @@ -669,6 +622,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"], checkUserCanBeAssigned: ["GET /repos/{owner}/{repo}/assignees/{assignee}"], + checkUserCanBeAssignedToIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}", + ], create: ["POST /repos/{owner}/{repo}/issues"], createComment: [ "POST /repos/{owner}/{repo}/issues/{issue_number}/comments", @@ -1380,7 +1336,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { {}, { deprecated: - "octokit.scim.addOrUpdateRepoPermissionsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.5/rest/reference/teams/#add-or-update-team-repository-permissions-legacy", + "octokit.scim.addOrUpdateRepoPermissionsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.5/rest/reference/teams#add-or-update-team-repository-permissions-legacy", }, ], checkPermissionsForProjectInOrg: [ diff --git a/src/generated/ghe-36-admin-endpoints.ts b/src/generated/ghe-36-admin-endpoints.ts index 888ba700..f838d2d5 100644 --- a/src/generated/ghe-36-admin-endpoints.ts +++ b/src/generated/ghe-36-admin-endpoints.ts @@ -26,13 +26,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "DELETE /admin/pre-receive-hooks/{pre_receive_hook_id}", ], deletePublicKey: ["DELETE /admin/keys/{key_ids}"], - deleteScimGroupFromEnterprise: [ - "DELETE /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - ], + deleteScimGroupFromEnterprise: ["DELETE /scim/v2/Groups/{scim_group_id}"], deleteUser: ["DELETE /admin/users/{username}"], - deleteUserFromEnterprise: [ - "DELETE /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - ], + deleteUserFromEnterprise: ["DELETE /scim/v2/Users/{scim_user_id}"], demoteSiteAdministrator: ["DELETE /users/{username}/site_admin"], disableSelectedOrganizationGithubActionsEnterprise: [ "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", @@ -77,10 +73,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "GET /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", ], getProvisioningInformationForEnterpriseGroup: [ - "GET /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", + "GET /scim/v2/Groups/{scim_group_id}", ], getProvisioningInformationForEnterpriseUser: [ - "GET /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", + "GET /scim/v2/Users/{scim_user_id}", ], getPullRequestStats: ["GET /enterprise/stats/pulls"], getRepoStats: ["GET /enterprise/stats/repos"], @@ -95,24 +91,16 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listPreReceiveHooks: ["GET /admin/pre-receive-hooks"], listPreReceiveHooksForOrg: ["GET /orgs/{org}/pre-receive-hooks"], listPreReceiveHooksForRepo: ["GET /repos/{owner}/{repo}/pre-receive-hooks"], - listProvisionedGroupsEnterprise: [ - "GET /scim/v2/enterprises/{enterprise}/Groups", - ], - listProvisionedIdentitiesEnterprise: [ - "GET /scim/v2/enterprises/{enterprise}/Users", - ], + listProvisionedGroupsEnterprise: ["GET /scim/v2/Groups"], + listProvisionedIdentitiesEnterprise: ["GET /scim/v2/Users"], listPublicKeys: ["GET /admin/keys"], listSelectedOrganizationsEnabledGithubActionsEnterprise: [ "GET /enterprises/{enterprise}/actions/permissions/organizations", ], pingGlobalWebhook: ["POST /admin/hooks/{hook_id}/pings"], promoteUserToBeSiteAdministrator: ["PUT /users/{username}/site_admin"], - provisionAndInviteEnterpriseGroup: [ - "POST /scim/v2/enterprises/{enterprise}/Groups", - ], - provisionAndInviteEnterpriseUser: [ - "POST /scim/v2/enterprises/{enterprise}/Users", - ], + provisionEnterpriseGroup: ["POST /scim/v2/Groups"], + provisionEnterpriseUser: ["POST /scim/v2/Users"], removeAllCustomLabelsFromSelfHostedRunnerForEnterprise: [ "DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels", ], @@ -140,10 +128,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "PUT /enterprises/{enterprise}/actions/permissions", ], setInformationForProvisionedEnterpriseGroup: [ - "PUT /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", + "PUT /scim/v2/Groups/{scim_group_id}", ], setInformationForProvisionedEnterpriseUser: [ - "PUT /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", + "PUT /scim/v2/Users/{scim_user_id}", ], setSelectedOrganizationsEnabledGithubActionsEnterprise: [ "PUT /enterprises/{enterprise}/actions/permissions/organizations", @@ -158,11 +146,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { syncLdapMappingForUser: ["POST /admin/ldap/users/{username}/sync"], unsuspendUser: ["DELETE /users/{username}/suspended"], updateAttributeForEnterpriseGroup: [ - "PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - ], - updateAttributeForEnterpriseUser: [ - "PATCH /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", + "PATCH /scim/v2/Groups/{scim_group_id}", ], + updateAttributeForEnterpriseUser: ["PATCH /scim/v2/Users/{scim_user_id}"], updateGlobalWebhook: ["PATCH /admin/hooks/{hook_id}"], updateLdapMappingForTeam: ["PATCH /admin/ldap/teams/{team_id}/mapping"], updateLdapMappingForUser: ["PATCH /admin/ldap/users/{username}/mapping"], diff --git a/src/generated/ghe-36-endpoints.ts b/src/generated/ghe-36-endpoints.ts index 842d7d73..5dd52fbe 100644 --- a/src/generated/ghe-36-endpoints.ts +++ b/src/generated/ghe-36-endpoints.ts @@ -302,22 +302,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { addRepoToInstallationForAuthenticatedUser: [ "PUT /user/installations/{installation_id}/repositories/{repository_id}", ], - checkAuthorization: [ - "GET /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.checkAuthorization() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#check-an-authorization", - }, - ], checkToken: ["POST /applications/{client_id}/token"], - createContentAttachment: [ - "POST /content_references/{content_reference_id}/attachments", - { mediaType: { previews: ["corsair"] } }, - ], - createContentAttachmentForRepo: [ - "POST /repos/{owner}/{repo}/content_references/{content_reference_id}/attachments", - ], createFromManifest: ["POST /app-manifests/{code}/conversions"], createInstallationAccessToken: [ "POST /app/installations/{installation_id}/access_tokens", @@ -351,31 +336,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { removeRepoFromInstallationForAuthenticatedUser: [ "DELETE /user/installations/{installation_id}/repositories/{repository_id}", ], - resetAuthorization: [ - "POST /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.resetAuthorization() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#reset-an-authorization", - }, - ], resetToken: ["PATCH /applications/{client_id}/token"], - revokeAuthorizationForApplication: [ - "DELETE /applications/{client_id}/tokens/{access_token}", - {}, - { - deprecated: - "octokit.scim.revokeAuthorizationForApplication() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-an-authorization-for-an-application", - }, - ], - revokeGrantForApplication: [ - "DELETE /applications/{client_id}/grants/{access_token}", - {}, - { - deprecated: - "octokit.scim.revokeGrantForApplication() is deprecated, see https://docs.github.com/enterprise-server@3.3/rest/reference/apps#revoke-a-grant-for-an-application", - }, - ], revokeInstallationAccessToken: ["DELETE /installation/token"], scopeToken: ["POST /applications/{client_id}/token/scoped"], suspendInstallation: ["PUT /app/installations/{installation_id}/suspended"], @@ -444,14 +405,6 @@ const Endpoints: EndpointsDefaultsAndDecorations = { codesOfConduct: { getAllCodesOfConduct: ["GET /codes_of_conduct"], getConductCode: ["GET /codes_of_conduct/{key}"], - getForRepo: [ - "GET /repos/{owner}/{repo}/community/code_of_conduct", - { mediaType: { previews: ["scarlet-witch"] } }, - { - deprecated: - "octokit.scim.getForRepo() is deprecated, see https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository", - }, - ], }, dependabot: { addSelectedRepoToOrgSecret: [ @@ -519,13 +472,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "DELETE /admin/pre-receive-hooks/{pre_receive_hook_id}", ], deletePublicKey: ["DELETE /admin/keys/{key_ids}"], - deleteScimGroupFromEnterprise: [ - "DELETE /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - ], + deleteScimGroupFromEnterprise: ["DELETE /scim/v2/Groups/{scim_group_id}"], deleteUser: ["DELETE /admin/users/{username}"], - deleteUserFromEnterprise: [ - "DELETE /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", - ], + deleteUserFromEnterprise: ["DELETE /scim/v2/Users/{scim_user_id}"], demoteSiteAdministrator: ["DELETE /users/{username}/site_admin"], disableSelectedOrganizationGithubActionsEnterprise: [ "DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}", @@ -570,10 +519,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "GET /repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}", ], getProvisioningInformationForEnterpriseGroup: [ - "GET /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", + "GET /scim/v2/Groups/{scim_group_id}", ], getProvisioningInformationForEnterpriseUser: [ - "GET /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", + "GET /scim/v2/Users/{scim_user_id}", ], getPullRequestStats: ["GET /enterprise/stats/pulls"], getRepoStats: ["GET /enterprise/stats/repos"], @@ -588,24 +537,16 @@ const Endpoints: EndpointsDefaultsAndDecorations = { listPreReceiveHooks: ["GET /admin/pre-receive-hooks"], listPreReceiveHooksForOrg: ["GET /orgs/{org}/pre-receive-hooks"], listPreReceiveHooksForRepo: ["GET /repos/{owner}/{repo}/pre-receive-hooks"], - listProvisionedGroupsEnterprise: [ - "GET /scim/v2/enterprises/{enterprise}/Groups", - ], - listProvisionedIdentitiesEnterprise: [ - "GET /scim/v2/enterprises/{enterprise}/Users", - ], + listProvisionedGroupsEnterprise: ["GET /scim/v2/Groups"], + listProvisionedIdentitiesEnterprise: ["GET /scim/v2/Users"], listPublicKeys: ["GET /admin/keys"], listSelectedOrganizationsEnabledGithubActionsEnterprise: [ "GET /enterprises/{enterprise}/actions/permissions/organizations", ], pingGlobalWebhook: ["POST /admin/hooks/{hook_id}/pings"], promoteUserToBeSiteAdministrator: ["PUT /users/{username}/site_admin"], - provisionAndInviteEnterpriseGroup: [ - "POST /scim/v2/enterprises/{enterprise}/Groups", - ], - provisionAndInviteEnterpriseUser: [ - "POST /scim/v2/enterprises/{enterprise}/Users", - ], + provisionEnterpriseGroup: ["POST /scim/v2/Groups"], + provisionEnterpriseUser: ["POST /scim/v2/Users"], removeAllCustomLabelsFromSelfHostedRunnerForEnterprise: [ "DELETE /enterprises/{enterprise}/actions/runners/{runner_id}/labels", ], @@ -633,10 +574,10 @@ const Endpoints: EndpointsDefaultsAndDecorations = { "PUT /enterprises/{enterprise}/actions/permissions", ], setInformationForProvisionedEnterpriseGroup: [ - "PUT /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", + "PUT /scim/v2/Groups/{scim_group_id}", ], setInformationForProvisionedEnterpriseUser: [ - "PUT /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", + "PUT /scim/v2/Users/{scim_user_id}", ], setSelectedOrganizationsEnabledGithubActionsEnterprise: [ "PUT /enterprises/{enterprise}/actions/permissions/organizations", @@ -651,11 +592,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { syncLdapMappingForUser: ["POST /admin/ldap/users/{username}/sync"], unsuspendUser: ["DELETE /users/{username}/suspended"], updateAttributeForEnterpriseGroup: [ - "PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}", - ], - updateAttributeForEnterpriseUser: [ - "PATCH /scim/v2/enterprises/{enterprise}/Users/{scim_user_id}", + "PATCH /scim/v2/Groups/{scim_group_id}", ], + updateAttributeForEnterpriseUser: ["PATCH /scim/v2/Users/{scim_user_id}"], updateGlobalWebhook: ["PATCH /admin/hooks/{hook_id}"], updateLdapMappingForTeam: ["PATCH /admin/ldap/teams/{team_id}/mapping"], updateLdapMappingForUser: ["PATCH /admin/ldap/users/{username}/mapping"], @@ -722,6 +661,9 @@ const Endpoints: EndpointsDefaultsAndDecorations = { ], addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"], checkUserCanBeAssigned: ["GET /repos/{owner}/{repo}/assignees/{assignee}"], + checkUserCanBeAssignedToIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}", + ], create: ["POST /repos/{owner}/{repo}/issues"], createComment: [ "POST /repos/{owner}/{repo}/issues/{issue_number}/comments", @@ -1433,7 +1375,7 @@ const Endpoints: EndpointsDefaultsAndDecorations = { {}, { deprecated: - "octokit.scim.addOrUpdateRepoPermissionsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.6/rest/reference/teams/#add-or-update-team-repository-permissions-legacy", + "octokit.scim.addOrUpdateRepoPermissionsLegacy() is deprecated, see https://docs.github.com/enterprise-server@3.6/rest/reference/teams#add-or-update-team-repository-permissions-legacy", }, ], checkPermissionsForProjectInOrg: [ diff --git a/src/index.ts b/src/index.ts index 1492492f..132ae997 100644 --- a/src/index.ts +++ b/src/index.ts @@ -5,12 +5,6 @@ import { Octokit } from "@octokit/core"; import { VERSION } from "./version"; import { endpointsToMethods } from "./endpoints-to-methods"; -import ENDPOINTS_32 from "./generated/ghe-32-endpoints"; -import ADMIN_ENDPOINTS_32 from "./generated/ghe-32-admin-endpoints"; - -import ENDPOINTS_33 from "./generated/ghe-33-endpoints"; -import ADMIN_ENDPOINTS_33 from "./generated/ghe-33-admin-endpoints"; - import ENDPOINTS_34 from "./generated/ghe-34-endpoints"; import ADMIN_ENDPOINTS_34 from "./generated/ghe-34-admin-endpoints"; @@ -20,26 +14,6 @@ import ADMIN_ENDPOINTS_35 from "./generated/ghe-35-admin-endpoints"; import ENDPOINTS_36 from "./generated/ghe-36-endpoints"; import ADMIN_ENDPOINTS_36 from "./generated/ghe-36-admin-endpoints"; -export function enterpriseServer32Admin(octokit: Octokit) { - return endpointsToMethods(octokit, ADMIN_ENDPOINTS_32); -} -enterpriseServer32Admin.VERSION = VERSION; - -export function enterpriseServer32(octokit: Octokit) { - return endpointsToMethods(octokit, ENDPOINTS_32); -} -enterpriseServer32.VERSION = VERSION; - -export function enterpriseServer33Admin(octokit: Octokit) { - return endpointsToMethods(octokit, ADMIN_ENDPOINTS_33); -} -enterpriseServer33Admin.VERSION = VERSION; - -export function enterpriseServer33(octokit: Octokit) { - return endpointsToMethods(octokit, ENDPOINTS_33); -} -enterpriseServer33.VERSION = VERSION; - export function enterpriseServer34Admin(octokit: Octokit) { return endpointsToMethods(octokit, ADMIN_ENDPOINTS_34); }